{"_id":"590b71dce58e1a0f003958e8","__v":0,"parentDoc":null,"project":"558d9c32beb7c719007f6319","user":"58cadf93d223510f005d27db","category":{"_id":"590829c7ade4172d006a87b8","project":"558d9c32beb7c719007f6319","__v":0,"version":"558d9c33beb7c719007f631c","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-05-02T06:40:07.955Z","from_sync":false,"order":1,"slug":"administration-apis","title":"Administration APIs"},"githubsync":"","version":{"_id":"558d9c33beb7c719007f631c","project":"558d9c32beb7c719007f6319","__v":19,"createdAt":"2015-06-26T18:38:43.154Z","releaseDate":"2015-06-26T18:38:43.153Z","categories":["558d9c33beb7c719007f631d","558db0bc7afc102f008ed863","558db0d07afc102f008ed864","558db3c84cd25f0d00b7ecb2","558dbace7afc102f008ed894","558dbd104cd25f0d00b7ecca","558dbd4c4cd25f0d00b7eccb","559d3e858639bd21008e90a6","55bb8ca5a8400c2d00873e70","58fdfb438fbd2819000db9eb","590829c7ade4172d006a87b8","59082a11beedcf0f00235d87","5908bd2cba2afd23007d6d12","5908d1f64f544425002b6aae","591e5e9e2c1b1f0f000fa4e5","5a283434aba91f002834ea86","5a69fe5cde745d002c936c66","5a81e6ef761cf300127317f8","5a81e7d63b1e120012bed5a1"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-05-04T18:24:28.414Z","link_external":false,"link_url":"","sync_unique":"","hidden":true,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":26,"body":"[block:api-header]\n{\n  \"title\": \"Use the International Surcharges API to get international surcharge pricing\"\n}\n[/block]\nUse the International Surcharges API to retrieve the surcharge cost for an international phone number\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Base URL for International Surcharges\",\n  \"body\": \"https://secure.dialogtech.com/ibp_api.php\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Parameter List\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Required\",\n    \"h-2\": \"Accepts\",\n    \"h-3\": \"Max Length\",\n    \"h-4\": \"Notes\",\n    \"h-5\": \"Usage\",\n    \"0-0\": \"action\",\n    \"0-1\": \"Yes\",\n    \"0-2\": \"String: **cost.get_surcharge**\",\n    \"0-3\": \"n/a\",\n    \"0-4\": \"Only accepts **cost.get_surcharge** to get international surcharge costs\",\n    \"0-5\": \"Defines the API Call as \\\"International Surcharges\\\" type\",\n    \"1-0\": \"access_key\",\n    \"1-1\": \"Yes\",\n    \"1-2\": \"String\",\n    \"1-3\": \"n/a\",\n    \"2-0\": \"secret_access_key\",\n    \"2-1\": \"Yes\",\n    \"2-2\": \"String\",\n    \"2-3\": \"n/a\",\n    \"1-4\": \"Access Key from the Key Manager within a DialogTech account\",\n    \"1-5\": \"Credentials used for access to the API for a particular DialogTech account\",\n    \"2-5\": \"Credentials used for access to the API for a particular DialogTech account\",\n    \"2-4\": \"Secret Access Key from the Key Manager within a DialogTech account\",\n    \"3-0\": \"phone_list\",\n    \"3-1\": \"No\",\n    \"3-2\": \"String\",\n    \"3-3\": \"n/a\",\n    \"3-4\": \"Bar \\\"|\\\" delimited list of phone numbers\",\n    \"3-5\": \"A list of phone numbers to get surcharges for. All phone numbers must start with **011** *(Example: 0115712145762)*\"\n  },\n  \"cols\": 6,\n  \"rows\": 4\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Using this API\"\n}\n[/block]\nThese code examples are meant to show a basic method of accessing DialogTech's International Surcharges API.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<?php\\n  /*\\n    International Surcharges EX:\\n    This example will pull DialogTech's\\n    international surcharge for transfers\\n    to a specific international number\\n  */\\n\\n  // Create cURL resource\\n  $ch = curl_init(); \\n  $baseuri = \\\"https://secure.dialogtech.com/ibp_api.php?\\\";\\n\\n  // API Specific Static Parameters\\n  $action = \\\"cost.get_surcharge\\\";\\n\\n  // Required User Parameters To Request the API\\n  $access_key = \\\"foo\\\";\\n  $secret_access_key = \\\"bar\\\";\\n  \\n  // Non required parameters used to request toe API\\n  $phone_list = \\\"0115552001234|0115552527685\\\";\\n\\n\\n\\n  // Construct the full URL\\n  $full_url = $baseuri . \\\"&action=\\\" . $action .\\n    \\\"&access_key=\\\" . $access_key .\\n    \\\"&secret_access_key=\\\" . $secret_access_key .\\n    \\\"&phone_list=\\\" . $phone_list;\\n\\n\\n  // Set the URL\\n  curl_setopt($ch, CURLOPT_URL, $full_url);\\n\\n  // Sets the return options of the cURL to return the actual result from the curl request, and FALSE on failure\\n  curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);\\n\\n  // Sets the $output variable to the result of the curl\\n  $output = curl_exec($ch);\\n\\n  // Close curl resource to free up system resources\\n  curl_close($ch);\\n\\n  // Echo the XML response to the page\\n  echo $output;\\n?>\",\n      \"language\": \"text\",\n      \"name\": \"PHP Example\"\n    },\n    {\n      \"code\": \"curl -X \\\"\\\"\",\n      \"language\": \"text\",\n      \"name\": \"cURL\"\n    }\n  ]\n}\n[/block]\n**Example Response**\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?>\\n<!DOCTYPE response [\\n        <!ELEMENT response (result,result_description,rates)>\\n        <!ELEMENT result (#PCDATA)>\\n        <!ELEMENT result_description (#PCDATA)>\\n        <!ELEMENT rates (rate+)>\\n        <!ELEMENT rate (phone_number,surcharge)>\\n        <!ELEMENT phone_number (#PCDATA)>\\n        <!ELEMENT surcharge (#PCDATA)>\\n        ]>\\n<response>\\n  <result>success</result>\\n  <result_description>\\n  </result_description>\\n  <rates>\\n    <rate>\\n      <phone_number>0115552001234</phone_number>\\n      <surcharge>0.0185</surcharge>\\n    </rate>\\n    <rate>\\n      <phone_number>0115552527685</phone_number>\\n      <surcharge>0.0182</surcharge>\\n    </rate>\\n  </rates>\\n</response>\",\n      \"language\": \"xml\",\n      \"name\": \"xml\"\n    }\n  ]\n}\n[/block]\n*Rates shown in example response are subject to change*","excerpt":"Get the surcharge cost for an international phone number","slug":"cost-get-surcharge","type":"basic","title":"International Surcharges"}

International Surcharges

Get the surcharge cost for an international phone number

Use the International Surcharges API to get international surcharge pricing

Use the International Surcharges API to retrieve the surcharge cost for an international phone number

Base URL for International Surcharges

https://secure.dialogtech.com/ibp_api.php

Parameter List

Parameter
Required
Accepts
Max Length
Notes
Usage

action

Yes

String: cost.get_surcharge

n/a

Only accepts cost.get_surcharge to get international surcharge costs

Defines the API Call as "International Surcharges" type

access_key

Yes

String

n/a

Access Key from the Key Manager within a DialogTech account

Credentials used for access to the API for a particular DialogTech account

secret_access_key

Yes

String

n/a

Secret Access Key from the Key Manager within a DialogTech account

Credentials used for access to the API for a particular DialogTech account

phone_list

No

String

n/a

Bar "|" delimited list of phone numbers

A list of phone numbers to get surcharges for. All phone numbers must start with 011 (Example: 0115712145762)

Using this API

These code examples are meant to show a basic method of accessing DialogTech's International Surcharges API.

<?php
  /*
    International Surcharges EX:
    This example will pull DialogTech's
    international surcharge for transfers
    to a specific international number
  */

  // Create cURL resource
  $ch = curl_init(); 
  $baseuri = "https://secure.dialogtech.com/ibp_api.php?";

  // API Specific Static Parameters
  $action = "cost.get_surcharge";

  // Required User Parameters To Request the API
  $access_key = "foo";
  $secret_access_key = "bar";
  
  // Non required parameters used to request toe API
  $phone_list = "0115552001234|0115552527685";



  // Construct the full URL
  $full_url = $baseuri . "&action=" . $action .
    "&access_key=" . $access_key .
    "&secret_access_key=" . $secret_access_key .
    "&phone_list=" . $phone_list;


  // Set the URL
  curl_setopt($ch, CURLOPT_URL, $full_url);

  // Sets the return options of the cURL to return the actual result from the curl request, and FALSE on failure
  curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

  // Sets the $output variable to the result of the curl
  $output = curl_exec($ch);

  // Close curl resource to free up system resources
  curl_close($ch);

  // Echo the XML response to the page
  echo $output;
?>
curl -X ""

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE response [
        <!ELEMENT response (result,result_description,rates)>
        <!ELEMENT result (#PCDATA)>
        <!ELEMENT result_description (#PCDATA)>
        <!ELEMENT rates (rate+)>
        <!ELEMENT rate (phone_number,surcharge)>
        <!ELEMENT phone_number (#PCDATA)>
        <!ELEMENT surcharge (#PCDATA)>
        ]>
<response>
  <result>success</result>
  <result_description>
  </result_description>
  <rates>
    <rate>
      <phone_number>0115552001234</phone_number>
      <surcharge>0.0185</surcharge>
    </rate>
    <rate>
      <phone_number>0115552527685</phone_number>
      <surcharge>0.0182</surcharge>
    </rate>
  </rates>
</response>

Rates shown in example response are subject to change