{"_id":"591330e158a5463700d3dc8c","parentDoc":null,"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"},"__v":1,"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"},"user":"58cadf93d223510f005d27db","githubsync":"","project":"558d9c32beb7c719007f6319","updates":["59c2e38ab2b45c0010b79fd7"],"next":{"pages":[],"description":""},"createdAt":"2017-05-10T15:25:21.602Z","link_external":false,"link_url":"","sync_unique":"","hidden":true,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":2,"body":"[block:api-header]\n{\n  \"title\": \"Use the Number List API to get a list of tracking numbers in an account\"\n}\n[/block]\nUse the Number List API to get a list of tracking numbers within a DialogTech account.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Base URL for Number List\",\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: **routing.numbers**\",\n    \"0-3\": \"n/a\",\n    \"0-4\": \"Only accepts **routing.numbers** to get a list of tracking numbers in an account\",\n    \"0-5\": \"Defines the API Call as \\\"Number List\\\" 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\": \"format\",\n    \"3-1\": \"No\",\n    \"3-2\": \"**xml** or **csv**\",\n    \"3-3\": \"n/a\",\n    \"3-4\": \"**xml** - Return data in xml format\\n**csv** - Return data in csv format\",\n    \"3-5\": \"Determines the format used to return the report\"\n  },\n  \"cols\": 6,\n  \"rows\": 4\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Using this API\"\n}\n[/block]\n**Example Response**\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<?xml version='1.0' encoding='iso-8859-1'?>\\n<!DOCTYPE data [\\n  <!ELEMENT data (record+)>\\n  <!ELEMENT record (phone_number,phone_label)>\\n   <!ELEMENT phone_number (#PCDATA)>\\n   <!ELEMENT phone_label (#PCDATA)>\\n]>\\n<data>\\n    <record>\\n        <phone_number>1231231234</phone_number>\\n        <phone_label>Highway Billboard Number</phone_label>\\n    </record>\\n    <record>\\n        <phone_number>2223334444</phone_number>\\n        <phone_label>Main St. Bus Bench</phone_label>\\n    </record>\\n    <record>\\n        <phone_number>3334445555</phone_number>\\n        <phone_label>Business Card</phone_label>\\n    </record>\\n</data>\",\n      \"language\": \"xml\",\n      \"name\": \"xml\"\n    },\n    {\n      \"code\": \"\\\"phone_number\\\",\\\"phone_label\\\"\\n\\\"1231231234\\\",\\\"Highway Billboard Number\\\"\\n\\\"2223334444\\\",\\\"Main St. Bus Bench\\\"\\n\\\"3334445555\\\",\\\"Business Card\\\"\",\n      \"language\": \"text\",\n      \"name\": \"csv\"\n    }\n  ]\n}\n[/block]","excerpt":"API used to get a list of tracking numbers in an account","slug":"number-list","type":"basic","title":"Number List"}

Number List

API used to get a list of tracking numbers in an account

Use the Number List API to get a list of tracking numbers in an account

Use the Number List API to get a list of tracking numbers within a DialogTech account.

Parameter List

Parameter
Required
Accepts
Max Length
Notes
Usage

action

Yes

String: routing.numbers

n/a

Only accepts routing.numbers to get a list of tracking numbers in an account

Defines the API Call as "Number List" 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

format

No

xml or csv

n/a

xml - Return data in xml format
csv - Return data in csv format

Determines the format used to return the report

Using this API

Example Response

<?xml version='1.0' encoding='iso-8859-1'?>
<!DOCTYPE data [
  <!ELEMENT data (record+)>
  <!ELEMENT record (phone_number,phone_label)>
   <!ELEMENT phone_number (#PCDATA)>
   <!ELEMENT phone_label (#PCDATA)>
]>
<data>
    <record>
        <phone_number>1231231234</phone_number>
        <phone_label>Highway Billboard Number</phone_label>
    </record>
    <record>
        <phone_number>2223334444</phone_number>
        <phone_label>Main St. Bus Bench</phone_label>
    </record>
    <record>
        <phone_number>3334445555</phone_number>
        <phone_label>Business Card</phone_label>
    </record>
</data>
"phone_number","phone_label"
"1231231234","Highway Billboard Number"
"2223334444","Main St. Bus Bench"
"3334445555","Business Card"