{"info":{"_postman_id":"ae3e0dcf-973f-42aa-a1ed-7aa80a35ff97","name":"CTM API","description":"

The CallTrackingMetrics API provides a RESTful interface to call data, phone numbers, text messaging, and account management. To assist in integrating CallTrackingMetrics with your website, we also provide a JavaScript API that allows you to customize how our dynamic number swapping interacts with your website.

You may make requests using any of the following content types in the request header:

Content-Type: application/json
\n
Content-Type: application/x-www-form-urlencoded
\n
Content-Type: multipart/form-data
\n

Make sure the body matches the Content-Type. For example if you are going to submit a JSON body like { \"phone_number\": \"+18085551212\" }, make sure to make the request with a Content-Type: application/json header as well.

All REST API endpoints respond with JSON encoded data.

Content-Type: application/json

Authentication

We support two levels of REST API access: single account level and multi account level.

Single Account Level access grants you access to a single account and can be enabled within the Account Settings page for each account.
Multi Account Level access grants you access to all sub-accounts within an agency or enterprise account and can be enabled within the Agency Settings page.
For either level, once you have enabled API access, you will have an Access Key and Secret Key. Once enabled, there are also buttons to reset the keys or disable API access.

To authorize with the API we use Basic Authentication. You will use the API key and secret either for your account or agency to construct an Authorization header that is base64 encoded. For example:

GET /api/v1/accounts.json HTTP/1.1\nHost: api.calltrackingmetrics.com\nAuthorization: Basic ABC123....\n\n

API Usage / Rate Limits

CTM has the following limits on API usage:

10 requests / second.
\n
Excessive errors may be throttled
\n

API Reference

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Authentication","slug":"authentication"},{"content":"API Usage / Rate Limits","slug":"api-usage-rate-limits"},{"content":"API Reference","slug":"api-reference"}],"owner":"3917255","collectionId":"ae3e0dcf-973f-42aa-a1ed-7aa80a35ff97","publishedId":"UVsSLhnS","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-03-22T20:29:29.000Z"},"item":[{"name":"Authentication","item":[{"name":"authenticate user","id":"e2e9e3be-9b1b-4dc5-bd4f-549cf2daa8c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"warning":"This is a duplicate header and will be overridden by the Content-Type header generated by Postman.","key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"user","value":"testUser","type":"text"},{"key":"password","value":"secretpassword","type":"text"}]},"url":"https://{{host}}/{{base_path}}/authentication","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{access_key}}"},{"key":"password","value":"{{secret_key}}"}]},"isInherited":true,"source":{"_postman_id":"ae3e0dcf-973f-42aa-a1ed-7aa80a35ff97","id":"ae3e0dcf-973f-42aa-a1ed-7aa80a35ff97","name":"CTM API","type":"collection"}},"urlObject":{"protocol":"https","path":["{{base_path}}","authentication"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"65cd64ad-71d4-4f98-9519-31fc8e7a5861","name":"authenticate user - success","originalRequest":{"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"user","value":"testUser","type":"text"},{"key":"password","value":"secretpassword","type":"text"}]},"url":"https://{{host}}/{{base_path}}/authentication"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"openresty/1.15.8.2","enabled":true},{"key":"Date","value":"Wed, 20 May 2020 20:57:18 GMT","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"X-Frame-Options","value":"ALLOWALL","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"ETag","value":"W/\"efb4d991208f09b171be05c97f24b6aa\"","enabled":true},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate","enabled":true},{"key":"Set-Cookie","value":"_ctm2=Ykpsclczb2hKdU9MUCt3N1JTVFR3eEJXNUJWdGZ2SExXQjQyWG51MGUyd3VONU1IWWpxck1NdGxacDNkamJEbS81ZnhBeW8xMkRhNmJmb3h5NVlQbncxYlhqYUhiK1Y1OElDRXdqYStWWE9YNVdaQmpUWTJGdjBLanNLcmpHdEZ0eTAwWGJDc25qTzdkUHgvMTVZMlBqQ0ZxWTdWTm5NT0hCc1RDQnJ4a012R0ZNZVo5cHhyamVLdVZXa0JCbjJvc1VHSVhUNFhtR1dENTR6MEFzZFU5VHlRMkdLV3VYZ3hYemhZelJJOGtmcEJjWmpMQi94RXY3M1lqeWJZeGplcS0tVnFpTExqanNtbk02WFBLL2xBcUcxdz09--5eb53985782778ed2dabfb6d5d75db9bfa43032c; domain=.gloria-ctm.ngrok.io; path=/; expires=Thu, 21 May 2020 20:57:18 -0000; secure; HttpOnly","enabled":true},{"key":"X-Request-Id","value":"bc0e5add-f468-45f0-af04-4b247c86f448","enabled":true},{"key":"X-Runtime","value":"0.189559","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"token\": \"Fvsq6_Tw10etyjay\",\n \"expires\": \"Wed, 17 Jun 2020 01:56:50 GMT\",\n \"email\": \"testuser-api@calltrackingmetrics.com\",\n \"id\": \"USRF1234567890\",\n \"accounts\": 1,\n \"first_account\": {\n \"id\": 1,\n \"balance\": \"50.00\",\n \"name\": \"Test Acct 1\"\n }\n}"}],"_postman_id":"e2e9e3be-9b1b-4dc5-bd4f-549cf2daa8c1"}],"id":"bbf833b8-4592-4b9d-b04d-57237ab4ce43","_postman_id":"bbf833b8-4592-4b9d-b04d-57237ab4ce43","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{access_key}}"},{"key":"password","value":"{{secret_key}}"}]},"isInherited":true,"source":{"_postman_id":"ae3e0dcf-973f-42aa-a1ed-7aa80a35ff97","id":"ae3e0dcf-973f-42aa-a1ed-7aa80a35ff97","name":"CTM API","type":"collection"}}},{"name":"Access Control Groups","item":[{"name":"list of access control groups","id":"4b73292c-9af5-4169-87ba-4c9e2f50f5b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"{{Basic Auth}}"}],"url":"https://{{host}}/{{base_path}}/accounts/{{account_id}}/access_groups","description":"

get list of access groups

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

	required	comments
account_id	yes	the account id

get details of access groups

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

	required	comments
account_id	yes	the account id
access_group_id	yes	the access_group_id

update existing access groups

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

	required	comments
account_id	yes	the account id
access_group_id	yes	the access_group_id
name	no	the name of the access group
tracking_numbers	no	array of tracking number in +E.164 format, TPN ids, or ids
users	no	array of users email address or USR ids, or ids

update existing access groups

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

	required	comments
account_id	yes	the account id
access_group_id	yes	the access_group_id
name	no	the name of the access group
tracking_numbers	no	array of tracking number in +E.164 format, TPN ids, or ids
users	no	array of users email address or USR ids, or ids

update existing access groups

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

	required	comments
account_id	yes	the account id
access_group_id	yes	the access_group_id
name	no	the name of the access group
tracking_numbers	no	array of tracking number in +E.164 format, TPN ids, or ids
users	no	array of users email address or USR ids, or ids

get list of accounts, including information and statistics

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
status	no	one of active/canceled/paused, to filter by account status

","urlObject":{"protocol":"https","path":["{{base_path}}","accounts"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"873297b7-9134-4561-8373-e7bf6dd0cce1","name":"list of accounts","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{Basic Auth}}"},{"key":"Content-Type","value":"application/json"}],"url":"https://{{host}}/{{base_path}}/accounts"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"page\": 1,\n \"per_page\": 10,\n \"total_entries\": 2,\n \"total_pages\": 1,\n \"next_page\": null,\n \"previous_page\": null,\n \"accounts\": [\n {\n \"id\": 12345,\n \"name\": \"test1\",\n \"user_role\": \"admin\",\n \"status\": \"active\",\n \"created\": \"2019-08-13T13:27:43Z\",\n \"updated\": \"2019-10-18T13:40:23Z\",\n \"canceled\": null,\n \"voice_menus_url\": \"https://api.calltrackingmetrics.com/api/v1/accounts/12345/voice_menus.json\",\n \"numbers_url\": \"https://api.calltrackingmetrics.com/api/v1/accounts/12345/numbers.json\",\n \"user_licenses_url\": \"https://api.calltrackingmetrics.com/api/v1/accounts/12345/user_licenses.json\",\n \"receiving_numbers_url\": \"https://api.calltrackingmetrics.com/api/v1/accounts/12345/receiving_numbers.json\",\n \"sources_url\": \"https://api.calltrackingmetrics.com/api/v1/accounts/12345/sources.json\",\n \"users_url\": \"https://api.calltrackingmetrics.com/api/v1/accounts/12345/users.json\",\n \"webhooks_url\": \"https://api.calltrackingmetrics.com/api/v1/accounts/12345/webhooks.json\",\n \"calls_url\": \"https://api.calltrackingmetrics.com/api/v1/accounts/12345/calls.json\",\n \"queues_url\": \"https://api.calltrackingmetrics.com/api/v1/accounts/12345/lookup.json?object_type=call_queue\",\n \"schedules_url\": \"https://api.calltrackingmetrics.com/api/v1/accounts/12345/schedules.json\",\n \"geo_routes_url\": \"https://api.calltrackingmetrics.com/api/v1/accounts/12345/geo_routes.json\",\n \"url\": \"https://api.calltrackingmetrics.com/api/v1/accounts/12345.json\",\n \"agency_id\": 2\n },\n {\n \"id\": 12378,\n \"name\": \"test2\",\n \"user_role\": \"admin\",\n \"status\": \"canceled\",\n \"created\": \"2019-08-13T17:23:50Z\",\n \"updated\": \"2019-11-13T20:27:47Z\",\n \"canceled\": \"2019-11-13T20:27:47Z\",\n \"voice_menus_url\": \"https://api.calltrackingmetrics.com/api/v1/accounts/12378/voice_menus.json\",\n \"numbers_url\": \"https://api.calltrackingmetrics.com/api/v1/accounts/12378/numbers.json\",\n \"user_licenses_url\": \"https://api.calltrackingmetrics.com/api/v1/accounts/12378/user_licenses.json\",\n \"receiving_numbers_url\": \"https://api.calltrackingmetrics.com/api/v1/accounts/12378/receiving_numbers.json\",\n \"sources_url\": \"https://api.calltrackingmetrics.com/api/v1/accounts/12378/sources.json\",\n \"users_url\": \"https://api.calltrackingmetrics.com/api/v1/accounts/12378/users.json\",\n \"webhooks_url\": \"https://api.calltrackingmetrics.com/api/v1/accounts/12378/webhooks.json\",\n \"calls_url\": \"https://api.calltrackingmetrics.com/api/v1/accounts/12378/calls.json\",\n \"queues_url\": \"https://api.calltrackingmetrics.com/api/v1/accounts/12378/lookup.json?object_type=call_queue\",\n \"schedules_url\": \"https://api.calltrackingmetrics.com/api/v1/accounts/12378/schedules.json\",\n \"geo_routes_url\": \"https://api.calltrackingmetrics.com/api/v1/accounts/12378/geo_routes.json\",\n \"url\": \"https://api.calltrackingmetrics.com/api/v1/accounts/12378.json\",\n \"agency_id\": 2\n }\n ]\n}"}],"_postman_id":"d9e3f5ee-ba47-4e4a-a2db-d749d2072720"},{"name":"list of active account IDs and names","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","var jsonData = JSON.parse(responseBody);","tests[\"accounts is array\"] = Array.isArray(jsonData.accounts);","tests[\"1st account's id is integer\"] = Number.isInteger(jsonData.accounts[0].id);"]}}],"id":"a2cb65b0-bd69-4735-b349-0e29299473f0","request":{"method":"GET","header":[{"key":"Authorization","value":"{{Basic Auth}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{host}}/{{base_path}}/accounts.json?names=1&all=1","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
names	yes	1 to enable
all	yes	1 to enable

If you enable both names and all, a list of active account id's and account names will be returned.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id

Use get account status to determine if an account is active, stopped, or paused.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id

Create a sub-account within an agency, with agency/shared billing (as opposed to customer billing).

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account[name]	yes	the name of the account
account[timezone_hint]	no	a timezone name like `America/New_York` or `America/Los_Angeles`
billing_type	yes	the string `existing` which will cause the account to be under agency billing

JSON body example

{\n  \"account\": {\n      \"name\": \"testing 123\",\n      \"timezone\": \"America/Los_Angeles\"\n  },\n  \"billing_type\": \"existing\"\n}\n

\n
Note that account names are not required to be unique. You can use \"get list of accounts\" to lookup account names if you need to see if an account already exists.
\n

You can also create accounts linked to a Stripe account and a price schedule.

{\n  \"account\": {\n      \"name\": \"testing 123\",\n      \"website_url\": \"https://your-website.com/\",\n      \"contact_number\": \"+18005771872\",\n      \"timezone\": \"America/Los_Angeles\"\n  },\n  \"billing_type\": \"existing\",\n  \"external_billing\": {\n    \"type\": \"stripe\",\n    \"price_schedule_id\": 12345,\n    \"stripe_customer_id\": \"your stripe customer id\"\n  }\n}\n

Create a sub-account within an agency, with customer billing (as opposed to shared billing).

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account[name]	yes	the name of the account
account[timezone_hint]	no	a timezone name like `America/New_York` or `America/Los_Angeles`
account[payment_profiles_attributes]	yes	array of payment profiles (credit cards)
billing_type	yes	the string `new` which will cause the account to be customer billing

Payment Profiles Attributes have the following fields:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

field	comments
first_name	Card holder's first name
last_name	Card holder's last name
address	Street address of card
city	City for card's address
zip	Zip/postal code for card's address
country	Country for card's address
card_type	One of: visa, master, american_express, diners_club, discover, jcb
card_number	Credit card number
verification_value	The verification code from the back of the card
month	Expiration month
year	Expiration year

JSON body example

{\n  \"account\": {\n      \"name\": \"testing 123\",\n      \"timezone_hint\": \"America/Los_Angeles\",\n      \"payment_profiles_attributes\": [\n        {\"first_name\": \"John\",\n         \"last_name\": \"Doe\",\n         \"address\": \"123 Example St\",\n         \"city\": \"Severna Park\",\n         \"zip\": \"21146\",\n         \"country\": \"US\",\n         \"card_type\": \"visa\",\n         \"card_number\": \"4242424242424242\",\n         \"verification_value\": \"424\",\n         \"month\": \"01\",\n         \"year\": \"2029\"\n        }\n      ]\n  },\n  \"billing_type\": \"new\"\n}\n

\n
Note that account names are not required to be unique. You can use \"get list of accounts\" to lookup account names if you need to see if an account already exists.
\n

Cancel a sub-account within an agency

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the id of the account to cancel

This will cancel the account and release all of the tracking numbers associated with the account.

Update a sub-account within an agency.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the id of the account
account[name]	no	the name of the account
account[timezone_hint]	no	a timezone name like `America/New_York` or `America/Los_Angeles`
account[website]	no	the url for the account
account[contact_number]	no	a phone number for the account

\n
Note that account names are not required to be unique. You can use \"get list of accounts\" to look up account names if you need to see if an account already exists.
\n

Starting an account will start dynamically swapping numbers and permit calls to tracking numbers. This is the opposite of stopping an account.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id

Stopping an account will stop dynamically swapping numbers and prevent calls to tracking numbers. Compare to pausing an account.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id

Pausing an account will stop dynamically swapping numbers but calls to tracking numbers will still work. Compare to stopping an account.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id

Resuming an account will start dynamically swapping numbers. This is the opposite of pausing an account.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
retention_period	yes	one of 0, 30, 60, 90 corresponding to the number of days of data retained
I_Understand_That_This_Has_Permanent_Data_Retention_Implications	yes	send 1 to ackknowledge you understand and agree

To enable automatic redaction, you must be using the agency keys. Also, redaction must be enabled in the agency:

https://app.calltrackingmetrics.com/agencies/{{agency_id}}/edit#agency-behaviors
\"Allow accounts to enable redacting calls within the call log (useful for GDPR compliance)\"

\n","urlObject":{"protocol":"https","path":["{{base_path}}","accounts","{{account_id}}","enable_automatic_redaction"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"8e121d1a-810d-4b22-b6ec-79f6a758088f","name":"failure to agree when enable/disable automatic redaction","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{Basic Auth}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"retention_period\": 90\n}"},"url":"https://{{host}}/{{base_path}}/accounts/{{account_id}}/enable_automatic_redaction"},"status":"Not Acceptable","code":406,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"reason\": \"must agree that this has permanent data retention implications\"\n}"},{"id":"867e9ef9-499c-4886-8a62-dc84867e455b","name":"success enable automatic redaction","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{Basic Auth}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"retention_period\": 90,\n \"I_Understand_That_This_Has_Permanent_Data_Retention_Implications\": 1\n}"},"url":"https://{{host}}/{{base_path}}/accounts/{{account_id}}/enable_automatic_redaction"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"openresty/1.15.8.2","enabled":true},{"key":"Date","value":"Tue, 14 Jul 2020 21:00:13 GMT","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"X-Frame-Options","value":"ALLOWALL","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"ETag","value":"W/\"910f0b0e5712d5f55469ab8ba8764fb7\"","enabled":true},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate","enabled":true},{"key":"Set-Cookie","value":"_ctm2=OVFzRy9mYjZoUlRnQUJ1aUdOY3lDQ1JhTkE4V0xMTzJhdUNlUWNKSlhOWVpRbEJ3K1ZXdWJveWRlS2tmVW1iRllUcG5zMXNKZFZEMGc2UU5ybzBHRWVrVzJvNU5yTjBhR3dMSjR5Ry9nNFpMbjZKSCtXRFhYSmlCSHBXd0NROFEtLTRldjBmVjlrS3BKVnlmUXdGRzhaVEE9PQ%3D%3D--7f0e481e83d8e656d2e6387d044af2013b909f51; domain=.ctmdev.us; path=/; expires=Wed, 15 Jul 2020 13:00:13 -0000; secure; HttpOnly; SameSite=None","enabled":true},{"key":"X-Meta-Request-Version","value":"0.7.2","enabled":true},{"key":"X-Request-Id","value":"83543b40-1413-4940-8791-98e3ace9caca","enabled":true},{"key":"X-Runtime","value":"0.059224","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\"\n}"},{"id":"846a390d-1ca3-4e5c-8c89-1e68571a96cf","name":"invalid retention period enable automatic redaction","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{Basic Auth}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"retention_period\": 91,\n \"I_Understand_That_This_Has_Permanent_Data_Retention_Implications\": 1\n}"},"url":"https://{{host}}/{{base_path}}/accounts/{{account_id}}/enable_automatic_redaction"},"status":"Not Acceptable","code":406,"_postman_previewlanguage":"Text","header":null,"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"reason\": \"must specify a valid retention period\"\n}"}],"_postman_id":"97a09f68-9515-4175-8c76-830b9bac64a3"},{"name":"disable automatic redaction","id":"d153e921-7953-49db-8425-d35253b782e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{access_key}}"},{"key":"password","value":"{{secret_key}}"}],"advancedConfig":[{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"I_Understand_That_This_Has_Permanent_Data_Retention_Implications\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://{{host}}/{{base_path}}/accounts/{{account_id}}/disable_automatic_redaction","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
I_Understand_That_This_Has_Permanent_Data_Retention_Implications	yes	send 1 to ackknowledge you understand and agree

","urlObject":{"protocol":"https","path":["{{base_path}}","accounts","{{account_id}}","disable_automatic_redaction"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"99c743f2-a52c-43cc-92ee-c92cb2583df4","name":"success disable automatic redaction","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"I_Understand_That_This_Has_Permanent_Data_Retention_Implications\": 1\n}","options":{"raw":{"language":"json"}}},"url":"https://{{host}}/{{base_path}}/accounts/{{account_id}}/disable_automatic_redaction"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"openresty/1.15.8.2","enabled":true},{"key":"Date","value":"Tue, 14 Jul 2020 21:00:53 GMT","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"X-Frame-Options","value":"ALLOWALL","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"ETag","value":"W/\"910f0b0e5712d5f55469ab8ba8764fb7\"","enabled":true},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate","enabled":true},{"key":"Set-Cookie","value":"_ctm2=RXp1MjVpOEhyck1WcHZYSGU0WjVPeC9MVDhESW1zTGx5c3NFZUZDdnhsRHhFOXdqLzNrU3lneXJNS1pLQVljSjhkQUVmMEY4U2RQeHJzRGxlT1dUK1ZoMHhnRFFVZkFlQzhTRW83RGFNbHJtOStmMDZqMDE1cXEyaHNxVjQ1NVEtLVBQUGNhN2pRdThxc090NGFoelQ5ckE9PQ%3D%3D--5b45ed9705383a86e84ed8a8cf02f1aad24b4794; domain=.ctmdev.us; path=/; expires=Wed, 15 Jul 2020 13:00:53 -0000; secure; HttpOnly; SameSite=None","enabled":true},{"key":"X-Meta-Request-Version","value":"0.7.2","enabled":true},{"key":"X-Request-Id","value":"fdababde-8a1d-43ac-a33b-7481b060f3cc","enabled":true},{"key":"X-Runtime","value":"0.272070","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\"\n}"}],"_postman_id":"d153e921-7953-49db-8425-d35253b782e6"},{"name":"tracking script settings","id":"5577e779-8421-40f2-b06c-6d0838aa96d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://{{host}}/{{base_path}}/accounts/{{account_id}}/tracking_script_settings","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
cookie_duration	no	Set the duration that visitors will be associated to their original source. Default is 30 days. Setting this value to 0 will disable cookies.
use_third_party_cookies	no	Use third-party cookies
score_default_threshold	no	Set a threshold value between 1 and 99 to indicate whether visitor data should appear in the call log associated to a call
custom_code	no	Custom tracking allows you to inject additional tracking code into the call tracking script. This is useful when you have graphical phone numbers and need to hook into the CTMSourceEvent. This needs to be valid JavaScript.
blockips	no	Add IP addresses to block tracking from known locations. For example, you might want to turn visitor tracking off for your office or monitoring software.
exclusion_rules	no	Set the field, match, and rule to exclude certain domains from the tracking script. This is useful if you are using a live website editor and will prevent the tracking script from updating the source.

Returns the name and ID number of the agency

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
agent_id	yes	the agent id

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
agent_id	yes	the agent id

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
agent_id	yes	the agent id

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
agent_id	yes	the agent id
status	no	a list of comma separated statuses; if empty or missing return the status of every agent

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
agent_id	yes	the agent id
status	no	one of online, offline, or one of the statuses available for the account. if status is blank, the agent will be set to offline (Not Available.)

Get a list of account call settings.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id

List details of call setting

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
call_setting_id	yes	the call setting id NCF

Get account default call setting

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

	required	comments
account_id	yes	the account id

Set default call setting

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

	required	comments
account_id	yes	the account id
call_setting_id	yes	the call setting id

Get a list of account level call settings.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
call_setting_id	yes	the call setting id NCF

Update an account level call setting.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
call_setting_id	yes	the call setting id NCF
virtual_phone_number_ids	yes	array of virtual phone number ids (TPNs)

Update an account level call setting.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
call_setting_id	yes	the call setting id NCF

For the list of properties/parameters that can be modified, use the \"list details of a call setting\" endpoint. For instance, if you want to turn off inbound call recordings, send recordings_on: false in the JSON body.

Get a list of account level call settings.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
call_setting_id	yes	the call setting id NCF

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
filter	no	search string to look for messages with specific callerid, caller_number, called_number, source name, etc.
after	no	a token used to determine the next page of data following the currently viewed page.
per_page	no	the number of items per page, defaults to 10
start_date	no	the start date for the search (YYYY-MM-DD)
end_date	no	the end date for the search (YYYY-MM-DD)
time_duration	no	instead of a start_date and end_date, you can request a range. for example, last6hours, last7days, last2weeks, last3months, yesterday, today, thisweek, thismonth, lastweek, etc. the duration is limited to ~3 months of data.
start_day	no	used with time_duration and weeks to denote the first day of the week. for example, start_day=Sunday. the default is Monday
direction[]	no	you may optionally filter the type of call/activity from the endpoint by including multiple parameters direction[] which URL encoded woudl be direction[]= and has the following options: inbound,outbound,msg_inbound,msg_outbound,form
limit_fields[]	no	only return specific fields of interest from the API
all	no	if set to 1, returns results agency-wide instead of account-wide
stats	no	if set to 'on' return property stats that includes useful statistics regarding minutes, talk_time, ring_time, hold_time (i.e. count, total, mean, min, max, standard deviation)
with_time	no	set to 1 to enable filtering with time
contact_number	no	prefixed based searching and filtering by the contact phone number

example
for example to pull back the list of calls from 2015-01-01 to 2015-02-01 with only the audio and the call id

curl -u$key:$sec 'https://api.calltrackingmetrics.com/api/v1/accounts/{{your-account-id}}/calls.json?start_date=2015-01-01&end_date=2015-02-01&limit_fields\\[\\]=audio&limit_fields\\[\\]=id'\n\n

{\"calls\":[{\"id\":1ddddddddd},{\"id\":2ddddddddd},{\"id\":3dddddddddd},{\"id\":4ddddddddd},{\"id\":5ddddddddd},{\"audio\":\"https://calltrackingmetrics.com/api/v1/accounts/{{your-account-id}}/calls/CAddddddddddd/recording\",\"id\":2dddddddd},{\"id\":21dddddd},{\"id\":212ddddd},{\"id\":2ddddddd},{\"id\":2ddddddd}],\"page\":1,\"total_entries\":1168,\"total_pages\":117,\"per_page\":10,\"stats\":{},\"next_page\":\"https://api.calltrackingmetrics.com/api/v1/accounts/{{your-account-id}}/calls.json?end_date=2015-02-01&limit_fields[]=audio&limit_fields[]=id&after=token&start_date=2015-01-01\"}\n\n

filter rules

Filter rules allow you to specify additional field-level filtering of the calls (for use with the filter parameter listed above). For example, tracking_number:\"14105555555\" would filter to only show calls involving the tracking number +1-410-555-5555

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	comments
tracking_number	tracking number used, as a string of digits
source	the tracking source name
caller_number	contact phone number, as a string of digits
status	the call status, for example: in progress, no answer, answered, hangup, completed

sorting activities
sorting can be done by using the parameters:

order which allows you to sort the calls by the following dimensions:
metrics - the time of the call
caller - the name of the caller
source - the name of the source

paging through activity data
The response body for each request will include an after token when more records exists after the current record set. Include this after token in the next request to get another page of data.

schema
https://api.calltrackingmetrics.com/api/v1/accounts/{account_id}/calls/schema.json

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{access_key}}"},{"key":"password","value":"{{secret_key}}"}]},"isInherited":true,"source":{"_postman_id":"ae3e0dcf-973f-42aa-a1ed-7aa80a35ff97","id":"ae3e0dcf-973f-42aa-a1ed-7aa80a35ff97","name":"CTM API","type":"collection"}},"urlObject":{"protocol":"https","path":["{{base_path}}","accounts","{{account_id}}","calls"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"d5802ef3-6d8d-43ef-9447-16be71cd8ec6","name":"list of activities (calls/texts/chats/forms)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{Basic Auth}}"},{"key":"Content-Type","value":"application/json"}],"url":"https://{{host}}/{{base_path}}/accounts/{{account_id}}/calls"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"calls\": [\n {\n \"id\": 629,\n \"sid\": \"CAxxxxx\",\n \"account_id\": 12345,\n \"name\": \"Super Tester\",\n \"cnam\": \"Baltimore, MD\",\n \"search\": \"\",\n \"referrer\": \"\",\n \"location\": \"\",\n \"source\": \"Website\",\n \"source_id\": 1,\n \"source_sid\": \"TSxxxxx\",\n \"tgid\": 1,\n \"likelihood\": null,\n \"duration\": 45,\n \"direction\": \"inbound\",\n \"talk_time\": 38,\n \"ring_time\": 4,\n \"hold_time\": 3,\n \"wait_time\": 4000,\n \"parent_id\": null,\n \"email\": \"\",\n \"street\": \"\",\n \"city\": \"Test City\",\n \"state\": \"MD\",\n \"country\": \"US\",\n \"postal_code\": \"21201\",\n \"called_at\": \"2020-04-13 04:52 PM -04:00\",\n \"unix_time\": 1586811174,\n \"tracking_number_id\": 5,\n \"tracking_number_sid\": \"TPxxxxx\",\n \"tracking_number\": \"+13330004444\",\n \"tracking_label\": \"\",\n \"dial_status\": \"answered\",\n \"is_new_caller\": false,\n \"indexed_at\": 1586814131.1483169,\n \"inbound_rate_center\": {\n \"country\": \"US\",\n \"prefix\": \"1\",\n \"tollfree\": false\n },\n \"billed_amount\": 215.25,\n \"billed_at\": \"2020-04-13T20:53:42\",\n \"caller_number_split\": [\n \"1\",\n \"251\",\n \"286\",\n \"2740\"\n ],\n \"contact_number\": \"+12512862740\",\n \"excluded\": false,\n \"redacted\": false,\n \"tracking_number_format\": \"(333) 000-4444\",\n \"caller_number_format\": \"(251) 286-2740\",\n \"alternative_number\": \"+12512862740\",\n \"caller_number_complete\": \"+12512862740\",\n \"caller_number_bare\": \"2512862740\",\n \"tracking_number_bare\": \"3330004444\",\n \"caller_number\": \"+12512862740\",\n \"visitor\": false,\n \"call_path\": [\n {\n \"route_name\": \"Test\",\n \"route_id\": \"CQxxxxx\",\n \"route_type\": \"CallQueue\",\n \"started_at\": \"2020-04-13T16:52:54Z\"\n }\n ],\n \"left_talk_time\": 0,\n \"right_talk_time\": 0,\n \"transfers\": [],\n \"call_status\": \"answered\",\n \"status\": \"answered\",\n \"spotted\": [],\n \"salesforce\": {},\n \"audio\": \"https://app.calltrackingmetrics.com/api/v1/accounts/1/calls/CAxxxxx/recording\",\n \"callbacks\": [],\n \"emails\": [],\n \"day\": \"Monday\",\n \"month\": \"April\",\n \"hour\": \"04PM\",\n \"ga\": {\n \"cid\": \"1.629\"\n },\n \"tag_list\": [],\n \"notes\": \"\",\n \"latitude\": 39.242,\n \"longitude\": -76.6771,\n \"extended_lookup_on\": true,\n \"agent_id\": \"USxxxxx\",\n \"agent\": {\n \"name\": \"MOBILE Test Test\",\n \"email\": \"user@test.app\",\n \"id\": \"USxxxxx\"\n },\n \"legs\": [\n {\n \"started_at\": \"2020-04-13T20:53:02Z\",\n \"end_at\": \"2020-04-13T20:53:40Z\",\n \"sid\": \"CAxxxxx\",\n \"to\": null,\n \"from\": \"client:agent_2\",\n \"status\": \"completed\",\n \"tags\": \"\",\n \"pdd_ms\": 84,\n \"direction\": \"inbound\",\n \"disconnected_by\": \"callee\",\n \"from_carrier\": null,\n \"from_connection\": \"twilio_sdk\",\n \"to_carrier\": null,\n \"to_connection\": null,\n \"duration\": 39,\n \"connect_duration\": 38\n }\n ]\n },\n {\n \"id\": 628,\n \"sid\": \"CAxxxxx\",\n \"account_id\": 12345,\n \"name\": \"Test\",\n \"cnam\": \"User,Test\",\n \"search\": \"\",\n \"referrer\": \"\",\n \"location\": \"\",\n \"source\": \"Website\",\n \"source_id\": 1,\n \"source_sid\": \"TSxxxxx\",\n \"tgid\": 1,\n \"likelihood\": null,\n \"duration\": 7,\n \"direction\": \"inbound\",\n \"talk_time\": 0,\n \"ring_time\": 7,\n \"hold_time\": 0,\n \"wait_time\": 1000,\n \"parent_id\": null,\n \"email\": \"\",\n \"street\": \"\",\n \"city\": \"Severna Park\",\n \"state\": \"MD\",\n \"country\": \"US\",\n \"postal_code\": \"21202\",\n \"called_at\": \"2020-04-13 04:50 PM -04:00\",\n \"unix_time\": 1586811001,\n \"tracking_number_id\": 5,\n \"tracking_number_sid\": \"TPxxxxx\",\n \"tracking_number\": \"+13330004444\",\n \"tracking_label\": \"\",\n \"dial_status\": \"hangup\",\n \"is_new_caller\": false,\n \"indexed_at\": 1586811609.076177,\n \"inbound_rate_center\": {\n \"country\": \"US\",\n \"prefix\": \"1\",\n \"tollfree\": false\n },\n \"billed_amount\": 215.25,\n \"billed_at\": \"2020-04-13T20:50:09\",\n \"caller_number_split\": [\n \"1\",\n \"251\",\n \"286\",\n \"2740\"\n ],\n \"contact_number\": \"+12512862740\",\n \"excluded\": false,\n \"redacted\": false,\n \"tracking_number_format\": \"(333) 000-4444\",\n \"caller_number_format\": \"(251) 286-2740\",\n \"alternative_number\": \"+12512862740\",\n \"caller_number_complete\": \"+12512862740\",\n \"caller_number_bare\": \"2512862740\",\n \"tracking_number_bare\": \"3330004444\",\n \"caller_number\": \"+12512862740\",\n \"visitor\": false,\n \"call_path\": [\n {\n \"route_name\": \"Test\",\n \"route_id\": \"CQxxxxx\",\n \"route_type\": \"CallQueue\",\n \"started_at\": \"2020-04-13T16:50:01Z\"\n }\n ],\n \"left_talk_time\": 0,\n \"right_talk_time\": 0,\n \"transfers\": [],\n \"call_status\": \"hangup\",\n \"status\": \"hangup\",\n \"spotted\": [],\n \"salesforce\": {},\n \"callbacks\": [],\n \"emails\": [],\n \"day\": \"Monday\",\n \"month\": \"April\",\n \"hour\": \"04PM\",\n \"ga\": {\n \"cid\": \"1.628\"\n },\n \"tag_list\": [],\n \"notes\": \"\",\n \"latitude\": 39.2847,\n \"longitude\": -76.6205,\n \"extended_lookup_on\": true,\n \"legs\": [\n {\n \"started_at\": \"2020-04-13T20:50:01Z\",\n \"end_at\": \"2020-04-13T20:50:08Z\",\n \"sid\": \"CAxxxxx\",\n \"to\": \"+13330004444\",\n \"from\": \"+12512862740\",\n \"status\": \"completed\",\n \"tags\": \"silence\",\n \"pdd_ms\": 57,\n \"direction\": \"inbound\",\n \"disconnected_by\": \"caller\",\n \"from_carrier\": \"Verizon Wireless\",\n \"from_connection\": \"mobile\",\n \"to_carrier\": \"Twilio\",\n \"to_connection\": \"voip\",\n \"duration\": 7,\n \"connect_duration\": 7\n }\n ]\n },\n {\n \"id\": 627,\n \"sid\": \"CAxxxxx\",\n \"account_id\": 12345,\n \"name\": \"Super Tester\",\n \"cnam\": \"Baltimore, MD\",\n \"search\": \"\",\n \"referrer\": \"\",\n \"location\": \"\",\n \"source\": \"Website\",\n \"source_id\": 1,\n \"source_sid\": \"TSxxxxx\",\n \"tgid\": 1,\n \"likelihood\": null,\n \"duration\": 66,\n \"direction\": \"inbound\",\n \"talk_time\": 60,\n \"ring_time\": 3,\n \"hold_time\": 3,\n \"wait_time\": 3000,\n \"parent_id\": null,\n \"email\": \"\",\n \"street\": \"\",\n \"city\": \"Test City\",\n \"state\": \"MD\",\n \"country\": \"US\",\n \"postal_code\": \"21201\",\n \"called_at\": \"2020-04-13 04:49 PM -04:00\",\n \"unix_time\": 1586810987,\n \"tracking_number_id\": 5,\n \"tracking_number_sid\": \"TPxxxxx\",\n \"tracking_number\": \"+13330004444\",\n \"tracking_label\": \"\",\n \"dial_status\": \"answered\",\n \"is_new_caller\": false,\n \"indexed_at\": 1586814131.180714,\n \"inbound_rate_center\": {\n \"country\": \"US\",\n \"prefix\": \"1\",\n \"tollfree\": false\n },\n \"billed_amount\": 430.5,\n \"billed_at\": \"2020-04-13T20:50:56\",\n \"caller_number_split\": [\n \"1\",\n \"251\",\n \"286\",\n \"2740\"\n ],\n \"contact_number\": \"+12512862740\",\n \"excluded\": false,\n \"redacted\": false,\n \"tracking_number_format\": \"(333) 000-4444\",\n \"caller_number_format\": \"(251) 286-2740\",\n \"alternative_number\": \"+12512862740\",\n \"caller_number_complete\": \"+12512862740\",\n \"caller_number_bare\": \"2512862740\",\n \"tracking_number_bare\": \"3330004444\",\n \"caller_number\": \"+12512862740\",\n \"visitor\": false,\n \"call_path\": [\n {\n \"route_name\": \"Test\",\n \"route_id\": \"CQxxxxx\",\n \"route_type\": \"CallQueue\",\n \"started_at\": \"2020-04-13T16:49:47Z\"\n }\n ],\n \"left_talk_time\": 0,\n \"right_talk_time\": 0,\n \"transfers\": [],\n \"call_status\": \"answered\",\n \"status\": \"answered\",\n \"spotted\": [],\n \"salesforce\": {},\n \"audio\": \"https://app.calltrackingmetrics.com/api/v1/accounts/1/calls/CAxxxxx/recording\",\n \"callbacks\": [],\n \"emails\": [],\n \"day\": \"Monday\",\n \"month\": \"April\",\n \"hour\": \"04PM\",\n \"ga\": {\n \"cid\": \"1.627\"\n },\n \"tag_list\": [],\n \"notes\": \"\",\n \"latitude\": 39.242,\n \"longitude\": -76.6771,\n \"extended_lookup_on\": true,\n \"agent_id\": \"USxxxxx\",\n \"agent\": {\n \"name\": \"MOBILE Test Test\",\n \"email\": \"user@test.app\",\n \"id\": \"USxxxxx\"\n },\n \"legs\": [\n {\n \"started_at\": \"2020-04-13T20:49:54Z\",\n \"end_at\": \"2020-04-13T20:50:54Z\",\n \"sid\": \"CAxxxxx\",\n \"to\": null,\n \"from\": \"client:agent_2\",\n \"status\": \"completed\",\n \"tags\": \"\",\n \"pdd_ms\": 38,\n \"direction\": \"inbound\",\n \"disconnected_by\": \"callee\",\n \"from_carrier\": null,\n \"from_connection\": \"twilio_sdk\",\n \"to_carrier\": null,\n \"to_connection\": null,\n \"duration\": 60,\n \"connect_duration\": 60\n }\n ]\n },\n {\n \"id\": 626,\n \"sid\": \"CAxxxxx\",\n \"account_id\": 12345,\n \"name\": \"Super Tester\",\n \"cnam\": \"Baltimore, MD\",\n \"search\": \"\",\n \"referrer\": \"\",\n \"location\": \"\",\n \"source\": \"Website\",\n \"source_id\": 1,\n \"source_sid\": \"TSxxxxx\",\n \"tgid\": 1,\n \"likelihood\": null,\n \"duration\": 64,\n \"direction\": \"inbound\",\n \"talk_time\": 58,\n \"ring_time\": 3,\n \"hold_time\": 3,\n \"wait_time\": 3000,\n \"parent_id\": null,\n \"email\": \"\",\n \"street\": \"\",\n \"city\": \"Test City\",\n \"state\": \"MD\",\n \"country\": \"US\",\n \"postal_code\": \"21201\",\n \"called_at\": \"2020-04-13 04:44 PM -04:00\",\n \"unix_time\": 1586810680,\n \"tracking_number_id\": 5,\n \"tracking_number_sid\": \"TPxxxxx\",\n \"tracking_number\": \"+13330004444\",\n \"tracking_label\": \"\",\n \"dial_status\": \"answered\",\n \"is_new_caller\": false,\n \"indexed_at\": 1586814131.2266922,\n \"inbound_rate_center\": {\n \"country\": \"US\",\n \"prefix\": \"1\",\n \"tollfree\": false\n },\n \"billed_amount\": 430.5,\n \"billed_at\": \"2020-04-13T20:45:47\",\n \"caller_number_split\": [\n \"1\",\n \"251\",\n \"286\",\n \"2740\"\n ],\n \"contact_number\": \"+12512862740\",\n \"excluded\": false,\n \"redacted\": false,\n \"tracking_number_format\": \"(333) 000-4444\",\n \"caller_number_format\": \"(251) 286-2740\",\n \"alternative_number\": \"+12512862740\",\n \"caller_number_complete\": \"+12512862740\",\n \"caller_number_bare\": \"2512862740\",\n \"tracking_number_bare\": \"3330004444\",\n \"caller_number\": \"+12512862740\",\n \"visitor\": false,\n \"call_path\": [\n {\n \"route_name\": \"Test\",\n \"route_id\": \"CQxxxxx\",\n \"route_type\": \"CallQueue\",\n \"started_at\": \"2020-04-13T16:44:40Z\"\n }\n ],\n \"left_talk_time\": 0,\n \"right_talk_time\": 0,\n \"transfers\": [],\n \"call_status\": \"answered\",\n \"status\": \"answered\",\n \"spotted\": [],\n \"salesforce\": {},\n \"audio\": \"https://app.calltrackingmetrics.com/api/v1/accounts/1/calls/CAxxxxx/recording\",\n \"callbacks\": [],\n \"emails\": [],\n \"day\": \"Monday\",\n \"month\": \"April\",\n \"hour\": \"04PM\",\n \"ga\": {\n \"cid\": \"1.626\"\n },\n \"tag_list\": [],\n \"notes\": \"\",\n \"latitude\": 39.242,\n \"longitude\": -76.6771,\n \"extended_lookup_on\": true,\n \"agent_id\": \"USxxxxx\",\n \"agent\": {\n \"name\": \"MOBILE Test Test\",\n \"email\": \"user@test.app\",\n \"id\": \"USxxxxx\"\n },\n \"legs\": [\n {\n \"started_at\": \"2020-04-13T20:44:47Z\",\n \"end_at\": \"2020-04-13T20:45:45Z\",\n \"sid\": \"CAxxxxx\",\n \"to\": null,\n \"from\": \"client:agent_2\",\n \"status\": \"completed\",\n \"tags\": \"\",\n \"pdd_ms\": null,\n \"direction\": \"inbound\",\n \"disconnected_by\": null,\n \"from_carrier\": null,\n \"from_connection\": \"twilio_sdk\",\n \"to_carrier\": null,\n \"to_connection\": null,\n \"duration\": 58,\n \"connect_duration\": 58\n }\n ]\n },\n {\n \"id\": 625,\n \"sid\": \"CAxxxxx\",\n \"account_id\": 12345,\n \"name\": \"Super Tester\",\n \"cnam\": \"Baltimore, MD\",\n \"search\": \"\",\n \"referrer\": \"\",\n \"location\": \"\",\n \"source\": \"Website\",\n \"source_id\": 1,\n \"source_sid\": \"TSxxxxx\",\n \"tgid\": 1,\n \"likelihood\": null,\n \"duration\": 61,\n \"direction\": \"inbound\",\n \"talk_time\": 54,\n \"ring_time\": 4,\n \"hold_time\": 3,\n \"wait_time\": 4000,\n \"parent_id\": null,\n \"email\": \"\",\n \"street\": \"\",\n \"city\": \"Test City\",\n \"state\": \"MD\",\n \"country\": \"US\",\n \"postal_code\": \"21201\",\n \"called_at\": \"2020-04-13 04:36 PM -04:00\",\n \"unix_time\": 1586810199,\n \"tracking_number_id\": 5,\n \"tracking_number_sid\": \"TPxxxxx\",\n \"tracking_number\": \"+13330004444\",\n \"tracking_label\": \"\",\n \"dial_status\": \"answered\",\n \"is_new_caller\": false,\n \"indexed_at\": 1586812060.836095,\n \"inbound_rate_center\": {\n \"country\": \"US\",\n \"prefix\": \"1\",\n \"tollfree\": false\n },\n \"billed_amount\": 430.5,\n \"billed_at\": \"2020-04-13T20:37:42\",\n \"caller_number_split\": [\n \"1\",\n \"251\",\n \"286\",\n \"2740\"\n ],\n \"contact_number\": \"+12512862740\",\n \"excluded\": false,\n \"redacted\": false,\n \"tracking_number_format\": \"(333) 000-4444\",\n \"caller_number_format\": \"(251) 286-2740\",\n \"alternative_number\": \"+12512862740\",\n \"caller_number_complete\": \"+12512862740\",\n \"caller_number_bare\": \"2512862740\",\n \"tracking_number_bare\": \"3330004444\",\n \"caller_number\": \"+12512862740\",\n \"visitor\": false,\n \"call_path\": [\n {\n \"route_name\": \"Test\",\n \"route_id\": \"CQxxxxx\",\n \"route_type\": \"CallQueue\",\n \"started_at\": \"2020-04-13T16:36:39Z\"\n }\n ],\n \"left_talk_time\": 0,\n \"right_talk_time\": 0,\n \"transfers\": [],\n \"call_status\": \"answered\",\n \"status\": \"answered\",\n \"spotted\": [],\n \"salesforce\": {},\n \"audio\": \"https://app.calltrackingmetrics.com/api/v1/accounts/1/calls/CA5a5414516bb29d1c938f28619c791756/recording\",\n \"callbacks\": [],\n \"emails\": [],\n \"day\": \"Monday\",\n \"month\": \"April\",\n \"hour\": \"04PM\",\n \"ga\": {\n \"cid\": \"1.625\"\n },\n \"tag_list\": [],\n \"notes\": \"\",\n \"latitude\": 39.242,\n \"longitude\": -76.6771,\n \"extended_lookup_on\": true,\n \"agent_id\": \"USxxxxx\",\n \"agent\": {\n \"name\": \"MOBILE Test Test\",\n \"email\": \"user@test.app\",\n \"id\": \"USxxxxx\"\n },\n \"legs\": [\n {\n \"started_at\": \"2020-04-13T20:36:46Z\",\n \"end_at\": \"2020-04-13T20:37:40Z\",\n \"sid\": \"CAxxxxx\",\n \"to\": null,\n \"from\": \"client:agent_2\",\n \"status\": \"completed\",\n \"tags\": \"\",\n \"pdd_ms\": 189,\n \"direction\": \"inbound\",\n \"disconnected_by\": \"callee\",\n \"from_carrier\": null,\n \"from_connection\": \"twilio_sdk\",\n \"to_carrier\": null,\n \"to_connection\": null,\n \"duration\": 54,\n \"connect_duration\": 54\n }\n ]\n },\n {\n \"id\": 624,\n \"sid\": \"CAxxxxx\",\n \"account_id\": 12345,\n \"name\": \"Super Tester\",\n \"cnam\": \"Baltimore, MD\",\n \"search\": \"\",\n \"referrer\": \"\",\n \"location\": \"\",\n \"source\": \"Website\",\n \"source_id\": 1,\n \"source_sid\": \"TSxxxxx\",\n \"tgid\": 1,\n \"likelihood\": null,\n \"duration\": 264,\n \"direction\": \"inbound\",\n \"talk_time\": 258,\n \"ring_time\": 4,\n \"hold_time\": 2,\n \"wait_time\": 4000,\n \"parent_id\": null,\n \"email\": \"\",\n \"street\": \"\",\n \"city\": \"Test City\",\n \"state\": \"MD\",\n \"country\": \"US\",\n \"postal_code\": \"21201\",\n \"called_at\": \"2020-04-13 04:24 PM -04:00\",\n \"unix_time\": 1586809445,\n \"tracking_number_id\": 5,\n \"tracking_number_sid\": \"TPxxxxx\",\n \"tracking_number\": \"+13330004444\",\n \"tracking_label\": \"\",\n \"dial_status\": \"answered\",\n \"is_new_caller\": false,\n \"indexed_at\": 1586811511.0292811,\n \"inbound_rate_center\": {\n \"country\": \"US\",\n \"prefix\": \"1\",\n \"tollfree\": false\n },\n \"billed_amount\": 1076.25,\n \"billed_at\": \"2020-04-13T20:28:33\",\n \"caller_number_split\": [\n \"1\",\n \"251\",\n \"286\",\n \"2740\"\n ],\n \"contact_number\": \"+12512862740\",\n \"excluded\": false,\n \"redacted\": false,\n \"tracking_number_format\": \"(333) 000-4444\",\n \"caller_number_format\": \"(251) 286-2740\",\n \"alternative_number\": \"+12512862740\",\n \"caller_number_complete\": \"+12512862740\",\n \"caller_number_bare\": \"2512862740\",\n \"tracking_number_bare\": \"3330004444\",\n \"caller_number\": \"+12512862740\",\n \"visitor\": false,\n \"call_path\": [\n {\n \"route_name\": \"Test\",\n \"route_id\": \"CQxxxxx\",\n \"route_type\": \"CallQueue\",\n \"started_at\": \"2020-04-13T16:24:05Z\"\n }\n ],\n \"left_talk_time\": 0,\n \"right_talk_time\": 0,\n \"transfers\": [],\n \"call_status\": \"answered\",\n \"status\": \"answered\",\n \"spotted\": [],\n \"salesforce\": {},\n \"audio\": \"https://app.calltrackingmetrics.com/api/v1/accounts/1/calls/CA3831dae6efdcfe0a6a706ea5bfdae25d/recording\",\n \"callbacks\": [],\n \"emails\": [],\n \"day\": \"Monday\",\n \"month\": \"April\",\n \"hour\": \"04PM\",\n \"ga\": {\n \"cid\": \"1.624\"\n },\n \"tag_list\": [],\n \"notes\": \"\",\n \"latitude\": 39.242,\n \"longitude\": -76.6771,\n \"extended_lookup_on\": true,\n \"agent_id\": \"USxxxxx\",\n \"agent\": {\n \"name\": \"MOBILE Test Test\",\n \"email\": \"user@test.app\",\n \"id\": \"USxxxxx\"\n },\n \"legs\": [\n {\n \"started_at\": \"2020-04-13T20:24:13Z\",\n \"end_at\": \"2020-04-13T20:28:31Z\",\n \"sid\": \"CAxxxxx\",\n \"to\": null,\n \"from\": \"client:agent_2\",\n \"status\": \"completed\",\n \"tags\": \"\",\n \"pdd_ms\": null,\n \"direction\": \"inbound\",\n \"disconnected_by\": null,\n \"from_carrier\": null,\n \"from_connection\": \"twilio_sdk\",\n \"to_carrier\": null,\n \"to_connection\": null,\n \"duration\": null,\n \"connect_duration\": 258\n }\n ]\n },\n {\n \"id\": 623,\n \"sid\": \"CAxxxxx\",\n \"account_id\": 12345,\n \"name\": \"Test\",\n \"cnam\": \"User,Test\",\n \"search\": \"\",\n \"referrer\": \"\",\n \"location\": \"\",\n \"source\": \"Website\",\n \"source_id\": 1,\n \"source_sid\": \"TSxxxxx\",\n \"tgid\": 1,\n \"likelihood\": null,\n \"duration\": 91,\n \"direction\": \"inbound\",\n \"talk_time\": 83,\n \"ring_time\": 5,\n \"hold_time\": 3,\n \"wait_time\": 5000,\n \"parent_id\": null,\n \"email\": \"\",\n \"street\": \"\",\n \"city\": \"Severna Park\",\n \"state\": \"MD\",\n \"country\": \"US\",\n \"postal_code\": \"21202\",\n \"called_at\": \"2020-04-13 12:23 PM -04:00\",\n \"unix_time\": 1586795016,\n \"tracking_number_id\": 5,\n \"tracking_number_sid\": \"TPxxxxx\",\n \"tracking_number\": \"+13330004444\",\n \"tracking_label\": \"\",\n \"dial_status\": \"answered\",\n \"is_new_caller\": false,\n \"indexed_at\": 1586792867.965173,\n \"inbound_rate_center\": {\n \"country\": \"US\",\n \"prefix\": \"1\",\n \"tollfree\": false\n },\n \"billed_amount\": 430.5,\n \"billed_at\": \"2020-04-13T16:25:10\",\n \"caller_number_split\": [\n \"1\",\n \"251\",\n \"286\",\n \"2740\"\n ],\n \"contact_number\": \"+12512862740\",\n \"excluded\": false,\n \"redacted\": false,\n \"tracking_number_format\": \"(333) 000-4444\",\n \"caller_number_format\": \"(251) 286-2740\",\n \"alternative_number\": \"+12512862740\",\n \"caller_number_complete\": \"+12512862740\",\n \"caller_number_bare\": \"2512862740\",\n \"tracking_number_bare\": \"3330004444\",\n \"caller_number\": \"+12512862740\",\n \"visitor\": false,\n \"call_path\": [\n {\n \"route_name\": \"Test\",\n \"route_id\": \"CQxxxxx\",\n \"route_type\": \"CallQueue\",\n \"started_at\": \"2020-04-13T12:23:36Z\"\n }\n ],\n \"left_talk_time\": 0,\n \"right_talk_time\": 0,\n \"transfers\": [],\n \"call_status\": \"answered\",\n \"status\": \"answered\",\n \"spotted\": [],\n \"salesforce\": {},\n \"audio\": \"https://app.calltrackingmetrics.com/api/v1/accounts/1/calls/CAxxxxx/recording\",\n \"callbacks\": [],\n \"emails\": [],\n \"day\": \"Monday\",\n \"month\": \"April\",\n \"hour\": \"12PM\",\n \"ga\": {\n \"cid\": \"1.623\"\n },\n \"tag_list\": [],\n \"notes\": \"\",\n \"latitude\": 39.2847,\n \"longitude\": -76.6205,\n \"extended_lookup_on\": true,\n \"agent_id\": \"USxxxxx\",\n \"agent\": {\n \"name\": \"MOBILE Test Test\",\n \"email\": \"user@test.app\",\n \"id\": \"USxxxxx\"\n },\n \"legs\": [\n {\n \"started_at\": \"2020-04-13T16:23:45Z\",\n \"end_at\": \"2020-04-13T16:25:08Z\",\n \"sid\": \"CAxxxxx\",\n \"to\": null,\n \"from\": \"client:agent_2\",\n \"status\": \"completed\",\n \"tags\": \"\",\n \"pdd_ms\": 78,\n \"direction\": \"inbound\",\n \"disconnected_by\": null,\n \"from_carrier\": null,\n \"from_connection\": \"twilio_sdk\",\n \"to_carrier\": null,\n \"to_connection\": null,\n \"duration\": 83,\n \"connect_duration\": 83\n },\n {\n \"started_at\": \"2020-04-13T16:23:36Z\",\n \"end_at\": \"2020-04-13T16:25:07Z\",\n \"sid\": \"CAxxxxx\",\n \"to\": \"+13330004444\",\n \"from\": \"+12512862740\",\n \"status\": \"completed\",\n \"tags\": \"\",\n \"pdd_ms\": 64,\n \"direction\": \"inbound\",\n \"disconnected_by\": \"callee\",\n \"from_carrier\": \"Verizon Wireless\",\n \"from_connection\": \"mobile\",\n \"to_carrier\": \"Twilio\",\n \"to_connection\": \"voip\",\n \"duration\": 92,\n \"connect_duration\": 91\n }\n ]\n },\n {\n \"id\": 622,\n \"sid\": \"CAxxxxx\",\n \"account_id\": 12345,\n \"name\": \"Test\",\n \"cnam\": \"User,Test\",\n \"search\": \"\",\n \"referrer\": \"\",\n \"location\": \"\",\n \"source\": \"Website\",\n \"source_id\": 1,\n \"source_sid\": \"TSxxxxx\",\n \"tgid\": 1,\n \"likelihood\": null,\n \"duration\": 64,\n \"direction\": \"inbound\",\n \"talk_time\": 57,\n \"ring_time\": 4,\n \"hold_time\": 3,\n \"wait_time\": 4000,\n \"parent_id\": null,\n \"email\": \"\",\n \"street\": \"\",\n \"city\": \"Severna Park\",\n \"state\": \"MD\",\n \"country\": \"US\",\n \"postal_code\": \"21202\",\n \"called_at\": \"2020-04-13 11:28 AM -04:00\",\n \"unix_time\": 1586791698,\n \"tracking_number_id\": 5,\n \"tracking_number_sid\": \"TPxxxxx\",\n \"tracking_number\": \"+13330004444\",\n \"tracking_label\": \"\",\n \"dial_status\": \"answered\",\n \"is_new_caller\": false,\n \"indexed_at\": 1586793563.8557801,\n \"inbound_rate_center\": {\n \"country\": \"US\",\n \"prefix\": \"1\",\n \"tollfree\": false\n },\n \"billed_amount\": 430.5,\n \"billed_at\": \"2020-04-13T15:29:24\",\n \"caller_number_split\": [\n \"1\",\n \"251\",\n \"286\",\n \"2740\"\n ],\n \"contact_number\": \"+12512862740\",\n \"excluded\": false,\n \"redacted\": false,\n \"tracking_number_format\": \"(333) 000-4444\",\n \"caller_number_format\": \"(251) 286-2740\",\n \"alternative_number\": \"+12512862740\",\n \"caller_number_complete\": \"+12512862740\",\n \"caller_number_bare\": \"2512862740\",\n \"tracking_number_bare\": \"3330004444\",\n \"caller_number\": \"+12512862740\",\n \"visitor\": false,\n \"call_path\": [\n {\n \"route_name\": \"Test\",\n \"route_id\": \"CQxxxxx\",\n \"route_type\": \"CallQueue\",\n \"started_at\": \"2020-04-13T11:28:18Z\"\n }\n ],\n \"left_talk_time\": 0,\n \"right_talk_time\": 0,\n \"transfers\": [],\n \"call_status\": \"answered\",\n \"status\": \"answered\",\n \"spotted\": [],\n \"salesforce\": {},\n \"audio\": \"https://app.calltrackingmetrics.com/api/v1/accounts/1/calls/CAxxxxx/recording\",\n \"callbacks\": [],\n \"emails\": [],\n \"day\": \"Monday\",\n \"month\": \"April\",\n \"hour\": \"11AM\",\n \"ga\": {\n \"cid\": \"1.622\"\n },\n \"tag_list\": [],\n \"notes\": \"\",\n \"latitude\": 39.2847,\n \"longitude\": -76.6205,\n \"extended_lookup_on\": true,\n \"agent_id\": \"USxxxxx\",\n \"agent\": {\n \"name\": \"MOBILE Test Test\",\n \"email\": \"user@test.app\",\n \"id\": \"USxxxxx\"\n },\n \"legs\": [\n {\n \"started_at\": \"2020-04-13T15:28:26Z\",\n \"end_at\": \"2020-04-13T15:29:23Z\",\n \"sid\": \"CAxxxxx\",\n \"to\": null,\n \"from\": \"client:agent_2\",\n \"status\": \"completed\",\n \"tags\": \"\",\n \"pdd_ms\": 38,\n \"direction\": \"inbound\",\n \"disconnected_by\": \"callee\",\n \"from_carrier\": null,\n \"from_connection\": \"twilio_sdk\",\n \"to_carrier\": null,\n \"to_connection\": null,\n \"duration\": 57,\n \"connect_duration\": 57\n },\n {\n \"started_at\": \"2020-04-13T15:28:18Z\",\n \"end_at\": \"2020-04-13T15:29:22Z\",\n \"sid\": \"CAxxxxx\",\n \"to\": \"+13330004444\",\n \"from\": \"+12512862740\",\n \"status\": \"completed\",\n \"tags\": \"\",\n \"pdd_ms\": null,\n \"direction\": \"inbound\",\n \"disconnected_by\": null,\n \"from_carrier\": \"Verizon Wireless\",\n \"from_connection\": \"mobile\",\n \"to_carrier\": \"Twilio\",\n \"to_connection\": \"voip\",\n \"duration\": null,\n \"connect_duration\": 64\n }\n ]\n },\n {\n \"id\": 621,\n \"sid\": \"CAxxxxx\",\n \"account_id\": 12345,\n \"name\": \"Test\",\n \"cnam\": \"User,Test\",\n \"search\": \"\",\n \"referrer\": \"\",\n \"location\": \"\",\n \"source\": \"Website\",\n \"source_id\": 1,\n \"source_sid\": \"TSxxxxx\",\n \"tgid\": 1,\n \"likelihood\": null,\n \"duration\": 66,\n \"direction\": \"inbound\",\n \"talk_time\": 38,\n \"ring_time\": 20,\n \"hold_time\": 8,\n \"wait_time\": 20000,\n \"parent_id\": null,\n \"email\": \"\",\n \"street\": \"\",\n \"city\": \"Severna Park\",\n \"state\": \"MD\",\n \"country\": \"US\",\n \"postal_code\": \"21202\",\n \"called_at\": \"2020-04-13 11:26 AM -04:00\",\n \"unix_time\": 1586791609,\n \"tracking_number_id\": 5,\n \"tracking_number_sid\": \"TPxxxxx\",\n \"tracking_number\": \"+13330004444\",\n \"tracking_label\": \"\",\n \"dial_status\": \"answered\",\n \"is_new_caller\": false,\n \"indexed_at\": 1586793475.8501801,\n \"inbound_rate_center\": {\n \"country\": \"US\",\n \"prefix\": \"1\",\n \"tollfree\": false\n },\n \"billed_amount\": 430.5,\n \"billed_at\": \"2020-04-13T15:27:56\",\n \"caller_number_split\": [\n \"1\",\n \"251\",\n \"286\",\n \"2740\"\n ],\n \"contact_number\": \"+12512862740\",\n \"excluded\": false,\n \"redacted\": false,\n \"tracking_number_format\": \"(333) 000-4444\",\n \"caller_number_format\": \"(251) 286-2740\",\n \"alternative_number\": \"+12512862740\",\n \"caller_number_complete\": \"+12512862740\",\n \"caller_number_bare\": \"2512862740\",\n \"tracking_number_bare\": \"3330004444\",\n \"caller_number\": \"+12512862740\",\n \"visitor\": false,\n \"call_path\": [\n {\n \"route_name\": \"Test\",\n \"route_id\": \"CQxxxxx\",\n \"route_type\": \"CallQueue\",\n \"started_at\": \"2020-04-13T11:26:49Z\"\n }\n ],\n \"left_talk_time\": 0,\n \"right_talk_time\": 0,\n \"transfers\": [],\n \"call_status\": \"answered\",\n \"status\": \"answered\",\n \"spotted\": [],\n \"salesforce\": {},\n \"audio\": \"https://app.calltrackingmetrics.com/api/v1/accounts/1/calls/CAxxxxx/recording\",\n \"callbacks\": [],\n \"emails\": [],\n \"day\": \"Monday\",\n \"month\": \"April\",\n \"hour\": \"11AM\",\n \"ga\": {\n \"cid\": \"1.621\"\n },\n \"tag_list\": [],\n \"notes\": \"\",\n \"latitude\": 39.2847,\n \"longitude\": -76.6205,\n \"extended_lookup_on\": true,\n \"agent_id\": \"USxxxxx\",\n \"agent\": {\n \"name\": \"MOBILE Test Test\",\n \"email\": \"user@test.app\",\n \"id\": \"USxxxxx\"\n },\n \"legs\": [\n {\n \"started_at\": \"2020-04-13T15:27:14Z\",\n \"end_at\": \"2020-04-13T15:27:52Z\",\n \"sid\": \"CAxxxxx\",\n \"to\": null,\n \"from\": \"client:agent_2\",\n \"status\": \"completed\",\n \"tags\": \"\",\n \"pdd_ms\": null,\n \"direction\": \"inbound\",\n \"disconnected_by\": null,\n \"from_carrier\": null,\n \"from_connection\": null,\n \"to_carrier\": null,\n \"to_connection\": null,\n \"duration\": 38,\n \"connect_duration\": 38\n },\n {\n \"started_at\": \"2020-04-13T15:26:49Z\",\n \"end_at\": \"2020-04-13T15:27:55Z\",\n \"sid\": \"CAxxxxx\",\n \"to\": \"+13330004444\",\n \"from\": \"+12512862740\",\n \"status\": \"completed\",\n \"tags\": \"\",\n \"pdd_ms\": 563,\n \"direction\": \"inbound\",\n \"disconnected_by\": \"callee\",\n \"from_carrier\": \"Verizon Wireless\",\n \"from_connection\": \"mobile\",\n \"to_carrier\": \"Twilio\",\n \"to_connection\": \"voip\",\n \"duration\": 65,\n \"connect_duration\": 66\n }\n ]\n },\n {\n \"id\": 620,\n \"sid\": \"CAxxxxx\",\n \"account_id\": 12345,\n \"name\": \"Severna Park, MD\",\n \"cnam\": \"Severna Park, MD\",\n \"search\": \"\",\n \"referrer\": \"\",\n \"location\": \"\",\n \"source\": \"Website\",\n \"source_id\": 1,\n \"source_sid\": \"TSxxxxx\",\n \"tgid\": 1,\n \"likelihood\": null,\n \"duration\": 17,\n \"direction\": \"inbound\",\n \"talk_time\": 0,\n \"ring_time\": 17,\n \"hold_time\": 0,\n \"wait_time\": 11000,\n \"parent_id\": null,\n \"email\": null,\n \"street\": null,\n \"city\": \"\",\n \"state\": \"MD\",\n \"country\": \"US\",\n \"postal_code\": \"\",\n \"called_at\": \"2020-04-13 11:21 AM -04:00\",\n \"unix_time\": 1586791301,\n \"tracking_number_id\": 5,\n \"tracking_number_sid\": \"TPxxxxx\",\n \"tracking_number\": \"+13330004444\",\n \"tracking_label\": \"\",\n \"dial_status\": \"hangup\",\n \"is_new_caller\": false,\n \"indexed_at\": 1586791918.719323,\n \"inbound_rate_center\": {\n \"country\": \"US\",\n \"prefix\": \"1\",\n \"tollfree\": false\n },\n \"billed_amount\": 215.25,\n \"billed_at\": \"2020-04-13T15:21:59\",\n \"caller_number_split\": [\n \"1\",\n \"251\",\n \"915\",\n \"0174\"\n ],\n \"contact_number\": \"+12512862740\",\n \"excluded\": false,\n \"redacted\": false,\n \"tracking_number_format\": \"(333) 000-4444\",\n \"caller_number_format\": \"(251) 915-0174\",\n \"alternative_number\": \"2512862740\",\n \"caller_number_complete\": \"+12512862740\",\n \"caller_number_bare\": \"2512862740\",\n \"tracking_number_bare\": \"3330004444\",\n \"caller_number\": \"+12512862740\",\n \"visitor\": false,\n \"call_path\": [\n {\n \"route_name\": \"Test\",\n \"route_id\": \"CQxxxxx\",\n \"route_type\": \"CallQueue\",\n \"started_at\": \"2020-04-13T11:21:41Z\"\n }\n ],\n \"left_talk_time\": 0,\n \"right_talk_time\": 0,\n \"transfers\": [],\n \"call_status\": \"hangup\",\n \"status\": \"hangup\",\n \"spotted\": [],\n \"salesforce\": {},\n \"callbacks\": [],\n \"emails\": [],\n \"day\": \"Monday\",\n \"month\": \"April\",\n \"hour\": \"11AM\",\n \"ga\": {\n \"cid\": \"1.620\"\n },\n \"tag_list\": [],\n \"latitude\": 38.9525,\n \"longitude\": -76.7012,\n \"extended_lookup_on\": true,\n \"legs\": [\n {\n \"started_at\": \"2020-04-13T15:21:41Z\",\n \"end_at\": \"2020-04-13T15:21:58Z\",\n \"sid\": \"CAxxxxx\",\n \"to\": \"+13330004444\",\n \"from\": \"+12512862740\",\n \"status\": \"completed\",\n \"tags\": \"\",\n \"pdd_ms\": 102,\n \"direction\": \"inbound\",\n \"disconnected_by\": \"caller\",\n \"from_carrier\": \"Verizon Wireless\",\n \"from_connection\": \"mobile\",\n \"to_carrier\": \"Twilio\",\n \"to_connection\": \"voip\",\n \"duration\": 17,\n \"connect_duration\": 17\n }\n ]\n }\n ],\n \"sort\": [\n {\n \"unix_time\": {\n \"order\": \"desc\",\n \"missing\": \"_last\"\n }\n }\n ],\n \"total_entries\": 616,\n \"total_pages\": 62,\n \"per_page\": 10,\n \"stats\": {},\n \"after\": \"MTxxxxx\",\n \"next_page\": \"https://app.calltrackingmetrics.com/api/v1/accounts/1/calls?after=MTUxxxxx\"\n}"}],"_postman_id":"58876022-1920-4796-9361-13547b418234"},{"name":"search activities","event":[{"listen":"test","script":{"id":"a76338b8-2405-45ba-a5d1-a117bed361f5","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","var jsonData = JSON.parse(responseBody);","tests[\"calls is an array\"] = Array.isArray(jsonData.calls);"],"type":"text/javascript"}}],"id":"2297d53c-bd8e-4c47-91fa-aa4958ef62cb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{Basic Auth}}"},{"key":"Content-Type","value":"application/json"}],"url":"https://{{host}}/{{base_path}}/accounts/{{account_id}}/calls/search.json","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
filter	no	search string to look for messages with specific callerid, caller_number, called_number, source name, etc.
page	no	the page number
per_page	no	the number of items per page, defaults to 10
start_date	no	the start date for the search (YYYY-MM-DD)
end_date	no	the end date for the search (YYYY-MM-DD)
time_duration	no	instead of a start_date and end_date, you can request a range. for example, last6hours, last7days, last2weeks, last3months, yesterday, today, thisweek, thismonth, lastweek, etc. the duration is limited to ~3 months of data.
start_day	no	used with time_duration and weeks to denote the first day of the week. for example, start_day=Sunday. the default is Monday
direction[]	no	you may optionally filter the type of call/activity from the endpoint by including multiple parameters direction[] which URL encoded woudl be direction%5B%5D= and has the following options: inbound,outbound,msg_inbound,msg_outbound,form
limit_fields[]	no	only return specific fields of interest from the API
all	no	if set to 1, returns results agency-wide instead of account-wide
stats	no	if set to 'on' return property stats that includes useful statistics regarding minutes, talk_time, ring_time, hold_time (i.e. count, total, mean, min, max, standard deviation)
with_time	no	set to 1 to enable filtering with time
contact_number	no	prefixed based searching and filtering by the contact phone number

example\nfor example to pull back the list of calls from 2015-01-01 to 2015-02-01 with only the audio and the call id

curl -XPOST -u$key:$sec 'https://api.calltrackingmetrics.com/api/v1/accounts/{{your-account-id}}/calls/search.json'\n-d '{\"start_date\": \"2015-01-01\", \"end_date\":\"2015-02-01\",\"limit_fields\": [\"audio\", \"id\"]}'\n\n

{\"calls\":[{\"id\":1ddddddddd},{\"id\":2ddddddddd},{\"id\":3dddddddddd},{\"id\":4ddddddddd},{\"id\":5ddddddddd},{\"audio\":\"https://calltrackingmetrics.com/api/v1/accounts/{{your-account-id}}/calls/CAddddddddddd/recording\",\"id\":2dddddddd},{\"id\":21dddddd},{\"id\":212ddddd},{\"id\":2ddddddd},{\"id\":2ddddddd}],\"page\":1,\"total_entries\":1168,\"total_pages\":117,\"per_page\":10,\"stats\":{},\"next_page\":\"https://api.calltrackingmetrics.com/api/v1/accounts/{{your-account-id}}/calls.json?end_date=2015-02-01&limit_fields%5B%5D=audio&limit_fields%5B%5D=id&page=2&start_date=2015-01-01\"}\n

Query Object

The query object is included in the request body allows you to specify additional field-level filtering of the calls (for use with the filter parameter listed above). For example, tracking_number:\"14105555555\" would filter to only show calls involving the tracking number +1-410-555-5555

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	comments
tracking_number	tracking number used, as a string of digits
source	the tracking source name
caller_number	contact phone number, as a string of digits
status	the call status, for example: in progress, no answer, answered, hangup, completed

sorting activities\nsorting can be done by using the parameters:

order which allows you to sort the calls by the following dimensions:\nmetrics - the time of the call\ncaller - the name of the caller\nsource - the name of the source

paging through activity data\nThe response body for each request will include an after property when more records exists after the current record set. Include this after token in the next request to get another page of data.

\n","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{access_key}}"},{"key":"password","value":"{{secret_key}}"}]},"isInherited":true,"source":{"_postman_id":"ae3e0dcf-973f-42aa-a1ed-7aa80a35ff97","id":"ae3e0dcf-973f-42aa-a1ed-7aa80a35ff97","name":"CTM API","type":"collection"}},"urlObject":{"protocol":"https","path":["{{base_path}}","accounts","{{account_id}}","calls","search.json"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[{"id":"c39d70cd-1b17-467a-9e63-1350ce728ae9","name":"search (calls/texts/chats/forms)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{Basic Auth}}"},{"key":"Content-Type","value":"application/json"}],"url":"https://{{host}}/{{base_path}}/accounts/{{account_id}}/calls/search.json"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"calls\": [\n {\n \"id\": 629,\n \"sid\": \"CAxxxxx\",\n \"account_id\": 12345,\n \"name\": \"Super Tester\",\n \"cnam\": \"Baltimore, MD\",\n \"search\": \"\",\n \"referrer\": \"\",\n \"location\": \"\",\n \"source\": \"Website\",\n \"source_id\": 1,\n \"source_sid\": \"TSxxxxx\",\n \"tgid\": 1,\n \"likelihood\": null,\n \"duration\": 45,\n \"direction\": \"inbound\",\n \"talk_time\": 38,\n \"ring_time\": 4,\n \"hold_time\": 3,\n \"wait_time\": 4000,\n \"parent_id\": null,\n \"email\": \"\",\n \"street\": \"\",\n \"city\": \"Test City\",\n \"state\": \"MD\",\n \"country\": \"US\",\n \"postal_code\": \"21201\",\n \"called_at\": \"2020-04-13 04:52 PM -04:00\",\n \"unix_time\": 1586811174,\n \"tracking_number_id\": 5,\n \"tracking_number_sid\": \"TPxxxxx\",\n \"tracking_number\": \"+13330004444\",\n \"tracking_label\": \"\",\n \"dial_status\": \"answered\",\n \"is_new_caller\": false,\n \"indexed_at\": 1586814131.1483169,\n \"inbound_rate_center\": {\n \"country\": \"US\",\n \"prefix\": \"1\",\n \"tollfree\": false\n },\n \"billed_amount\": 215.25,\n \"billed_at\": \"2020-04-13T20:53:42\",\n \"caller_number_split\": [\n \"1\",\n \"251\",\n \"286\",\n \"2740\"\n ],\n \"contact_number\": \"+12512862740\",\n \"excluded\": false,\n \"redacted\": false,\n \"tracking_number_format\": \"(333) 000-4444\",\n \"caller_number_format\": \"(251) 286-2740\",\n \"alternative_number\": \"+12512862740\",\n \"caller_number_complete\": \"+12512862740\",\n \"caller_number_bare\": \"2512862740\",\n \"tracking_number_bare\": \"3330004444\",\n \"caller_number\": \"+12512862740\",\n \"visitor\": false,\n \"call_path\": [\n {\n \"route_name\": \"Test\",\n \"route_id\": \"CQxxxxx\",\n \"route_type\": \"CallQueue\",\n \"started_at\": \"2020-04-13T16:52:54Z\"\n }\n ],\n \"left_talk_time\": 0,\n \"right_talk_time\": 0,\n \"transfers\": [],\n \"call_status\": \"answered\",\n \"status\": \"answered\",\n \"spotted\": [],\n \"salesforce\": {},\n \"audio\": \"https://app.calltrackingmetrics.com/api/v1/accounts/1/calls/CAxxxxx/recording\",\n \"callbacks\": [],\n \"emails\": [],\n \"day\": \"Monday\",\n \"month\": \"April\",\n \"hour\": \"04PM\",\n \"ga\": {\n \"cid\": \"1.629\"\n },\n \"tag_list\": [],\n \"notes\": \"\",\n \"latitude\": 39.242,\n \"longitude\": -76.6771,\n \"extended_lookup_on\": true,\n \"agent_id\": \"USxxxxx\",\n \"agent\": {\n \"name\": \"MOBILE Test Test\",\n \"email\": \"user@test.app\",\n \"id\": \"USxxxxx\"\n },\n \"legs\": [\n {\n \"started_at\": \"2020-04-13T20:53:02Z\",\n \"end_at\": \"2020-04-13T20:53:40Z\",\n \"sid\": \"CAxxxxx\",\n \"to\": null,\n \"from\": \"client:agent_2\",\n \"status\": \"completed\",\n \"tags\": \"\",\n \"pdd_ms\": 84,\n \"direction\": \"inbound\",\n \"disconnected_by\": \"callee\",\n \"from_carrier\": null,\n \"from_connection\": \"twilio_sdk\",\n \"to_carrier\": null,\n \"to_connection\": null,\n \"duration\": 39,\n \"connect_duration\": 38\n }\n ]\n },\n {\n \"id\": 628,\n \"sid\": \"CAxxxxx\",\n \"account_id\": 12345,\n \"name\": \"Test\",\n \"cnam\": \"User,Test\",\n \"search\": \"\",\n \"referrer\": \"\",\n \"location\": \"\",\n \"source\": \"Website\",\n \"source_id\": 1,\n \"source_sid\": \"TSxxxxx\",\n \"tgid\": 1,\n \"likelihood\": null,\n \"duration\": 7,\n \"direction\": \"inbound\",\n \"talk_time\": 0,\n \"ring_time\": 7,\n \"hold_time\": 0,\n \"wait_time\": 1000,\n \"parent_id\": null,\n \"email\": \"\",\n \"street\": \"\",\n \"city\": \"Severna Park\",\n \"state\": \"MD\",\n \"country\": \"US\",\n \"postal_code\": \"21202\",\n \"called_at\": \"2020-04-13 04:50 PM -04:00\",\n \"unix_time\": 1586811001,\n \"tracking_number_id\": 5,\n \"tracking_number_sid\": \"TPxxxxx\",\n \"tracking_number\": \"+13330004444\",\n \"tracking_label\": \"\",\n \"dial_status\": \"hangup\",\n \"is_new_caller\": false,\n \"indexed_at\": 1586811609.076177,\n \"inbound_rate_center\": {\n \"country\": \"US\",\n \"prefix\": \"1\",\n \"tollfree\": false\n },\n \"billed_amount\": 215.25,\n \"billed_at\": \"2020-04-13T20:50:09\",\n \"caller_number_split\": [\n \"1\",\n \"251\",\n \"286\",\n \"2740\"\n ],\n \"contact_number\": \"+12512862740\",\n \"excluded\": false,\n \"redacted\": false,\n \"tracking_number_format\": \"(333) 000-4444\",\n \"caller_number_format\": \"(251) 286-2740\",\n \"alternative_number\": \"+12512862740\",\n \"caller_number_complete\": \"+12512862740\",\n \"caller_number_bare\": \"2512862740\",\n \"tracking_number_bare\": \"3330004444\",\n \"caller_number\": \"+12512862740\",\n \"visitor\": false,\n \"call_path\": [\n {\n \"route_name\": \"Test\",\n \"route_id\": \"CQxxxxx\",\n \"route_type\": \"CallQueue\",\n \"started_at\": \"2020-04-13T16:50:01Z\"\n }\n ],\n \"left_talk_time\": 0,\n \"right_talk_time\": 0,\n \"transfers\": [],\n \"call_status\": \"hangup\",\n \"status\": \"hangup\",\n \"spotted\": [],\n \"salesforce\": {},\n \"callbacks\": [],\n \"emails\": [],\n \"day\": \"Monday\",\n \"month\": \"April\",\n \"hour\": \"04PM\",\n \"ga\": {\n \"cid\": \"1.628\"\n },\n \"tag_list\": [],\n \"notes\": \"\",\n \"latitude\": 39.2847,\n \"longitude\": -76.6205,\n \"extended_lookup_on\": true,\n \"legs\": [\n {\n \"started_at\": \"2020-04-13T20:50:01Z\",\n \"end_at\": \"2020-04-13T20:50:08Z\",\n \"sid\": \"CAxxxxx\",\n \"to\": \"+13330004444\",\n \"from\": \"+12512862740\",\n \"status\": \"completed\",\n \"tags\": \"silence\",\n \"pdd_ms\": 57,\n \"direction\": \"inbound\",\n \"disconnected_by\": \"caller\",\n \"from_carrier\": \"Verizon Wireless\",\n \"from_connection\": \"mobile\",\n \"to_carrier\": \"Twilio\",\n \"to_connection\": \"voip\",\n \"duration\": 7,\n \"connect_duration\": 7\n }\n ]\n },\n {\n \"id\": 627,\n \"sid\": \"CAxxxxx\",\n \"account_id\": 12345,\n \"name\": \"Super Tester\",\n \"cnam\": \"Baltimore, MD\",\n \"search\": \"\",\n \"referrer\": \"\",\n \"location\": \"\",\n \"source\": \"Website\",\n \"source_id\": 1,\n \"source_sid\": \"TSxxxxx\",\n \"tgid\": 1,\n \"likelihood\": null,\n \"duration\": 66,\n \"direction\": \"inbound\",\n \"talk_time\": 60,\n \"ring_time\": 3,\n \"hold_time\": 3,\n \"wait_time\": 3000,\n \"parent_id\": null,\n \"email\": \"\",\n \"street\": \"\",\n \"city\": \"Test City\",\n \"state\": \"MD\",\n \"country\": \"US\",\n \"postal_code\": \"21201\",\n \"called_at\": \"2020-04-13 04:49 PM -04:00\",\n \"unix_time\": 1586810987,\n \"tracking_number_id\": 5,\n \"tracking_number_sid\": \"TPxxxxx\",\n \"tracking_number\": \"+13330004444\",\n \"tracking_label\": \"\",\n \"dial_status\": \"answered\",\n \"is_new_caller\": false,\n \"indexed_at\": 1586814131.180714,\n \"inbound_rate_center\": {\n \"country\": \"US\",\n \"prefix\": \"1\",\n \"tollfree\": false\n },\n \"billed_amount\": 430.5,\n \"billed_at\": \"2020-04-13T20:50:56\",\n \"caller_number_split\": [\n \"1\",\n \"251\",\n \"286\",\n \"2740\"\n ],\n \"contact_number\": \"+12512862740\",\n \"excluded\": false,\n \"redacted\": false,\n \"tracking_number_format\": \"(333) 000-4444\",\n \"caller_number_format\": \"(251) 286-2740\",\n \"alternative_number\": \"+12512862740\",\n \"caller_number_complete\": \"+12512862740\",\n \"caller_number_bare\": \"2512862740\",\n \"tracking_number_bare\": \"3330004444\",\n \"caller_number\": \"+12512862740\",\n \"visitor\": false,\n \"call_path\": [\n {\n \"route_name\": \"Test\",\n \"route_id\": \"CQxxxxx\",\n \"route_type\": \"CallQueue\",\n \"started_at\": \"2020-04-13T16:49:47Z\"\n }\n ],\n \"left_talk_time\": 0,\n \"right_talk_time\": 0,\n \"transfers\": [],\n \"call_status\": \"answered\",\n \"status\": \"answered\",\n \"spotted\": [],\n \"salesforce\": {},\n \"audio\": \"https://app.calltrackingmetrics.com/api/v1/accounts/1/calls/CAxxxxx/recording\",\n \"callbacks\": [],\n \"emails\": [],\n \"day\": \"Monday\",\n \"month\": \"April\",\n \"hour\": \"04PM\",\n \"ga\": {\n \"cid\": \"1.627\"\n },\n \"tag_list\": [],\n \"notes\": \"\",\n \"latitude\": 39.242,\n \"longitude\": -76.6771,\n \"extended_lookup_on\": true,\n \"agent_id\": \"USxxxxx\",\n \"agent\": {\n \"name\": \"MOBILE Test Test\",\n \"email\": \"user@test.app\",\n \"id\": \"USxxxxx\"\n },\n \"legs\": [\n {\n \"started_at\": \"2020-04-13T20:49:54Z\",\n \"end_at\": \"2020-04-13T20:50:54Z\",\n \"sid\": \"CAxxxxx\",\n \"to\": null,\n \"from\": \"client:agent_2\",\n \"status\": \"completed\",\n \"tags\": \"\",\n \"pdd_ms\": 38,\n \"direction\": \"inbound\",\n \"disconnected_by\": \"callee\",\n \"from_carrier\": null,\n \"from_connection\": \"twilio_sdk\",\n \"to_carrier\": null,\n \"to_connection\": null,\n \"duration\": 60,\n \"connect_duration\": 60\n }\n ]\n },\n {\n \"id\": 626,\n \"sid\": \"CAxxxxx\",\n \"account_id\": 12345,\n \"name\": \"Super Tester\",\n \"cnam\": \"Baltimore, MD\",\n \"search\": \"\",\n \"referrer\": \"\",\n \"location\": \"\",\n \"source\": \"Website\",\n \"source_id\": 1,\n \"source_sid\": \"TSxxxxx\",\n \"tgid\": 1,\n \"likelihood\": null,\n \"duration\": 64,\n \"direction\": \"inbound\",\n \"talk_time\": 58,\n \"ring_time\": 3,\n \"hold_time\": 3,\n \"wait_time\": 3000,\n \"parent_id\": null,\n \"email\": \"\",\n \"street\": \"\",\n \"city\": \"Test City\",\n \"state\": \"MD\",\n \"country\": \"US\",\n \"postal_code\": \"21201\",\n \"called_at\": \"2020-04-13 04:44 PM -04:00\",\n \"unix_time\": 1586810680,\n \"tracking_number_id\": 5,\n \"tracking_number_sid\": \"TPxxxxx\",\n \"tracking_number\": \"+13330004444\",\n \"tracking_label\": \"\",\n \"dial_status\": \"answered\",\n \"is_new_caller\": false,\n \"indexed_at\": 1586814131.2266922,\n \"inbound_rate_center\": {\n \"country\": \"US\",\n \"prefix\": \"1\",\n \"tollfree\": false\n },\n \"billed_amount\": 430.5,\n \"billed_at\": \"2020-04-13T20:45:47\",\n \"caller_number_split\": [\n \"1\",\n \"251\",\n \"286\",\n \"2740\"\n ],\n \"contact_number\": \"+12512862740\",\n \"excluded\": false,\n \"redacted\": false,\n \"tracking_number_format\": \"(333) 000-4444\",\n \"caller_number_format\": \"(251) 286-2740\",\n \"alternative_number\": \"+12512862740\",\n \"caller_number_complete\": \"+12512862740\",\n \"caller_number_bare\": \"2512862740\",\n \"tracking_number_bare\": \"3330004444\",\n \"caller_number\": \"+12512862740\",\n \"visitor\": false,\n \"call_path\": [\n {\n \"route_name\": \"Test\",\n \"route_id\": \"CQxxxxx\",\n \"route_type\": \"CallQueue\",\n \"started_at\": \"2020-04-13T16:44:40Z\"\n }\n ],\n \"left_talk_time\": 0,\n \"right_talk_time\": 0,\n \"transfers\": [],\n \"call_status\": \"answered\",\n \"status\": \"answered\",\n \"spotted\": [],\n \"salesforce\": {},\n \"audio\": \"https://app.calltrackingmetrics.com/api/v1/accounts/1/calls/CAxxxxx/recording\",\n \"callbacks\": [],\n \"emails\": [],\n \"day\": \"Monday\",\n \"month\": \"April\",\n \"hour\": \"04PM\",\n \"ga\": {\n \"cid\": \"1.626\"\n },\n \"tag_list\": [],\n \"notes\": \"\",\n \"latitude\": 39.242,\n \"longitude\": -76.6771,\n \"extended_lookup_on\": true,\n \"agent_id\": \"USxxxxx\",\n \"agent\": {\n \"name\": \"MOBILE Test Test\",\n \"email\": \"user@test.app\",\n \"id\": \"USxxxxx\"\n },\n \"legs\": [\n {\n \"started_at\": \"2020-04-13T20:44:47Z\",\n \"end_at\": \"2020-04-13T20:45:45Z\",\n \"sid\": \"CAxxxxx\",\n \"to\": null,\n \"from\": \"client:agent_2\",\n \"status\": \"completed\",\n \"tags\": \"\",\n \"pdd_ms\": null,\n \"direction\": \"inbound\",\n \"disconnected_by\": null,\n \"from_carrier\": null,\n \"from_connection\": \"twilio_sdk\",\n \"to_carrier\": null,\n \"to_connection\": null,\n \"duration\": 58,\n \"connect_duration\": 58\n }\n ]\n },\n {\n \"id\": 625,\n \"sid\": \"CAxxxxx\",\n \"account_id\": 12345,\n \"name\": \"Super Tester\",\n \"cnam\": \"Baltimore, MD\",\n \"search\": \"\",\n \"referrer\": \"\",\n \"location\": \"\",\n \"source\": \"Website\",\n \"source_id\": 1,\n \"source_sid\": \"TSxxxxx\",\n \"tgid\": 1,\n \"likelihood\": null,\n \"duration\": 61,\n \"direction\": \"inbound\",\n \"talk_time\": 54,\n \"ring_time\": 4,\n \"hold_time\": 3,\n \"wait_time\": 4000,\n \"parent_id\": null,\n \"email\": \"\",\n \"street\": \"\",\n \"city\": \"Test City\",\n \"state\": \"MD\",\n \"country\": \"US\",\n \"postal_code\": \"21201\",\n \"called_at\": \"2020-04-13 04:36 PM -04:00\",\n \"unix_time\": 1586810199,\n \"tracking_number_id\": 5,\n \"tracking_number_sid\": \"TPxxxxx\",\n \"tracking_number\": \"+13330004444\",\n \"tracking_label\": \"\",\n \"dial_status\": \"answered\",\n \"is_new_caller\": false,\n \"indexed_at\": 1586812060.836095,\n \"inbound_rate_center\": {\n \"country\": \"US\",\n \"prefix\": \"1\",\n \"tollfree\": false\n },\n \"billed_amount\": 430.5,\n \"billed_at\": \"2020-04-13T20:37:42\",\n \"caller_number_split\": [\n \"1\",\n \"251\",\n \"286\",\n \"2740\"\n ],\n \"contact_number\": \"+12512862740\",\n \"excluded\": false,\n \"redacted\": false,\n \"tracking_number_format\": \"(333) 000-4444\",\n \"caller_number_format\": \"(251) 286-2740\",\n \"alternative_number\": \"+12512862740\",\n \"caller_number_complete\": \"+12512862740\",\n \"caller_number_bare\": \"2512862740\",\n \"tracking_number_bare\": \"3330004444\",\n \"caller_number\": \"+12512862740\",\n \"visitor\": false,\n \"call_path\": [\n {\n \"route_name\": \"Test\",\n \"route_id\": \"CQxxxxx\",\n \"route_type\": \"CallQueue\",\n \"started_at\": \"2020-04-13T16:36:39Z\"\n }\n ],\n \"left_talk_time\": 0,\n \"right_talk_time\": 0,\n \"transfers\": [],\n \"call_status\": \"answered\",\n \"status\": \"answered\",\n \"spotted\": [],\n \"salesforce\": {},\n \"audio\": \"https://app.calltrackingmetrics.com/api/v1/accounts/1/calls/CA5a5414516bb29d1c938f28619c791756/recording\",\n \"callbacks\": [],\n \"emails\": [],\n \"day\": \"Monday\",\n \"month\": \"April\",\n \"hour\": \"04PM\",\n \"ga\": {\n \"cid\": \"1.625\"\n },\n \"tag_list\": [],\n \"notes\": \"\",\n \"latitude\": 39.242,\n \"longitude\": -76.6771,\n \"extended_lookup_on\": true,\n \"agent_id\": \"USxxxxx\",\n \"agent\": {\n \"name\": \"MOBILE Test Test\",\n \"email\": \"user@test.app\",\n \"id\": \"USxxxxx\"\n },\n \"legs\": [\n {\n \"started_at\": \"2020-04-13T20:36:46Z\",\n \"end_at\": \"2020-04-13T20:37:40Z\",\n \"sid\": \"CAxxxxx\",\n \"to\": null,\n \"from\": \"client:agent_2\",\n \"status\": \"completed\",\n \"tags\": \"\",\n \"pdd_ms\": 189,\n \"direction\": \"inbound\",\n \"disconnected_by\": \"callee\",\n \"from_carrier\": null,\n \"from_connection\": \"twilio_sdk\",\n \"to_carrier\": null,\n \"to_connection\": null,\n \"duration\": 54,\n \"connect_duration\": 54\n }\n ]\n },\n {\n \"id\": 624,\n \"sid\": \"CAxxxxx\",\n \"account_id\": 12345,\n \"name\": \"Super Tester\",\n \"cnam\": \"Baltimore, MD\",\n \"search\": \"\",\n \"referrer\": \"\",\n \"location\": \"\",\n \"source\": \"Website\",\n \"source_id\": 1,\n \"source_sid\": \"TSxxxxx\",\n \"tgid\": 1,\n \"likelihood\": null,\n \"duration\": 264,\n \"direction\": \"inbound\",\n \"talk_time\": 258,\n \"ring_time\": 4,\n \"hold_time\": 2,\n \"wait_time\": 4000,\n \"parent_id\": null,\n \"email\": \"\",\n \"street\": \"\",\n \"city\": \"Test City\",\n \"state\": \"MD\",\n \"country\": \"US\",\n \"postal_code\": \"21201\",\n \"called_at\": \"2020-04-13 04:24 PM -04:00\",\n \"unix_time\": 1586809445,\n \"tracking_number_id\": 5,\n \"tracking_number_sid\": \"TPxxxxx\",\n \"tracking_number\": \"+13330004444\",\n \"tracking_label\": \"\",\n \"dial_status\": \"answered\",\n \"is_new_caller\": false,\n \"indexed_at\": 1586811511.0292811,\n \"inbound_rate_center\": {\n \"country\": \"US\",\n \"prefix\": \"1\",\n \"tollfree\": false\n },\n \"billed_amount\": 1076.25,\n \"billed_at\": \"2020-04-13T20:28:33\",\n \"caller_number_split\": [\n \"1\",\n \"251\",\n \"286\",\n \"2740\"\n ],\n \"contact_number\": \"+12512862740\",\n \"excluded\": false,\n \"redacted\": false,\n \"tracking_number_format\": \"(333) 000-4444\",\n \"caller_number_format\": \"(251) 286-2740\",\n \"alternative_number\": \"+12512862740\",\n \"caller_number_complete\": \"+12512862740\",\n \"caller_number_bare\": \"2512862740\",\n \"tracking_number_bare\": \"3330004444\",\n \"caller_number\": \"+12512862740\",\n \"visitor\": false,\n \"call_path\": [\n {\n \"route_name\": \"Test\",\n \"route_id\": \"CQxxxxx\",\n \"route_type\": \"CallQueue\",\n \"started_at\": \"2020-04-13T16:24:05Z\"\n }\n ],\n \"left_talk_time\": 0,\n \"right_talk_time\": 0,\n \"transfers\": [],\n \"call_status\": \"answered\",\n \"status\": \"answered\",\n \"spotted\": [],\n \"salesforce\": {},\n \"audio\": \"https://app.calltrackingmetrics.com/api/v1/accounts/1/calls/CA3831dae6efdcfe0a6a706ea5bfdae25d/recording\",\n \"callbacks\": [],\n \"emails\": [],\n \"day\": \"Monday\",\n \"month\": \"April\",\n \"hour\": \"04PM\",\n \"ga\": {\n \"cid\": \"1.624\"\n },\n \"tag_list\": [],\n \"notes\": \"\",\n \"latitude\": 39.242,\n \"longitude\": -76.6771,\n \"extended_lookup_on\": true,\n \"agent_id\": \"USxxxxx\",\n \"agent\": {\n \"name\": \"MOBILE Test Test\",\n \"email\": \"user@test.app\",\n \"id\": \"USxxxxx\"\n },\n \"legs\": [\n {\n \"started_at\": \"2020-04-13T20:24:13Z\",\n \"end_at\": \"2020-04-13T20:28:31Z\",\n \"sid\": \"CAxxxxx\",\n \"to\": null,\n \"from\": \"client:agent_2\",\n \"status\": \"completed\",\n \"tags\": \"\",\n \"pdd_ms\": null,\n \"direction\": \"inbound\",\n \"disconnected_by\": null,\n \"from_carrier\": null,\n \"from_connection\": \"twilio_sdk\",\n \"to_carrier\": null,\n \"to_connection\": null,\n \"duration\": null,\n \"connect_duration\": 258\n }\n ]\n },\n {\n \"id\": 623,\n \"sid\": \"CAxxxxx\",\n \"account_id\": 12345,\n \"name\": \"Test\",\n \"cnam\": \"User,Test\",\n \"search\": \"\",\n \"referrer\": \"\",\n \"location\": \"\",\n \"source\": \"Website\",\n \"source_id\": 1,\n \"source_sid\": \"TSxxxxx\",\n \"tgid\": 1,\n \"likelihood\": null,\n \"duration\": 91,\n \"direction\": \"inbound\",\n \"talk_time\": 83,\n \"ring_time\": 5,\n \"hold_time\": 3,\n \"wait_time\": 5000,\n \"parent_id\": null,\n \"email\": \"\",\n \"street\": \"\",\n \"city\": \"Severna Park\",\n \"state\": \"MD\",\n \"country\": \"US\",\n \"postal_code\": \"21202\",\n \"called_at\": \"2020-04-13 12:23 PM -04:00\",\n \"unix_time\": 1586795016,\n \"tracking_number_id\": 5,\n \"tracking_number_sid\": \"TPxxxxx\",\n \"tracking_number\": \"+13330004444\",\n \"tracking_label\": \"\",\n \"dial_status\": \"answered\",\n \"is_new_caller\": false,\n \"indexed_at\": 1586792867.965173,\n \"inbound_rate_center\": {\n \"country\": \"US\",\n \"prefix\": \"1\",\n \"tollfree\": false\n },\n \"billed_amount\": 430.5,\n \"billed_at\": \"2020-04-13T16:25:10\",\n \"caller_number_split\": [\n \"1\",\n \"251\",\n \"286\",\n \"2740\"\n ],\n \"contact_number\": \"+12512862740\",\n \"excluded\": false,\n \"redacted\": false,\n \"tracking_number_format\": \"(333) 000-4444\",\n \"caller_number_format\": \"(251) 286-2740\",\n \"alternative_number\": \"+12512862740\",\n \"caller_number_complete\": \"+12512862740\",\n \"caller_number_bare\": \"2512862740\",\n \"tracking_number_bare\": \"3330004444\",\n \"caller_number\": \"+12512862740\",\n \"visitor\": false,\n \"call_path\": [\n {\n \"route_name\": \"Test\",\n \"route_id\": \"CQxxxxx\",\n \"route_type\": \"CallQueue\",\n \"started_at\": \"2020-04-13T12:23:36Z\"\n }\n ],\n \"left_talk_time\": 0,\n \"right_talk_time\": 0,\n \"transfers\": [],\n \"call_status\": \"answered\",\n \"status\": \"answered\",\n \"spotted\": [],\n \"salesforce\": {},\n \"audio\": \"https://app.calltrackingmetrics.com/api/v1/accounts/1/calls/CAxxxxx/recording\",\n \"callbacks\": [],\n \"emails\": [],\n \"day\": \"Monday\",\n \"month\": \"April\",\n \"hour\": \"12PM\",\n \"ga\": {\n \"cid\": \"1.623\"\n },\n \"tag_list\": [],\n \"notes\": \"\",\n \"latitude\": 39.2847,\n \"longitude\": -76.6205,\n \"extended_lookup_on\": true,\n \"agent_id\": \"USxxxxx\",\n \"agent\": {\n \"name\": \"MOBILE Test Test\",\n \"email\": \"user@test.app\",\n \"id\": \"USxxxxx\"\n },\n \"legs\": [\n {\n \"started_at\": \"2020-04-13T16:23:45Z\",\n \"end_at\": \"2020-04-13T16:25:08Z\",\n \"sid\": \"CAxxxxx\",\n \"to\": null,\n \"from\": \"client:agent_2\",\n \"status\": \"completed\",\n \"tags\": \"\",\n \"pdd_ms\": 78,\n \"direction\": \"inbound\",\n \"disconnected_by\": null,\n \"from_carrier\": null,\n \"from_connection\": \"twilio_sdk\",\n \"to_carrier\": null,\n \"to_connection\": null,\n \"duration\": 83,\n \"connect_duration\": 83\n },\n {\n \"started_at\": \"2020-04-13T16:23:36Z\",\n \"end_at\": \"2020-04-13T16:25:07Z\",\n \"sid\": \"CAxxxxx\",\n \"to\": \"+13330004444\",\n \"from\": \"+12512862740\",\n \"status\": \"completed\",\n \"tags\": \"\",\n \"pdd_ms\": 64,\n \"direction\": \"inbound\",\n \"disconnected_by\": \"callee\",\n \"from_carrier\": \"Verizon Wireless\",\n \"from_connection\": \"mobile\",\n \"to_carrier\": \"Twilio\",\n \"to_connection\": \"voip\",\n \"duration\": 92,\n \"connect_duration\": 91\n }\n ]\n },\n {\n \"id\": 622,\n \"sid\": \"CAxxxxx\",\n \"account_id\": 12345,\n \"name\": \"Test\",\n \"cnam\": \"User,Test\",\n \"search\": \"\",\n \"referrer\": \"\",\n \"location\": \"\",\n \"source\": \"Website\",\n \"source_id\": 1,\n \"source_sid\": \"TSxxxxx\",\n \"tgid\": 1,\n \"likelihood\": null,\n \"duration\": 64,\n \"direction\": \"inbound\",\n \"talk_time\": 57,\n \"ring_time\": 4,\n \"hold_time\": 3,\n \"wait_time\": 4000,\n \"parent_id\": null,\n \"email\": \"\",\n \"street\": \"\",\n \"city\": \"Severna Park\",\n \"state\": \"MD\",\n \"country\": \"US\",\n \"postal_code\": \"21202\",\n \"called_at\": \"2020-04-13 11:28 AM -04:00\",\n \"unix_time\": 1586791698,\n \"tracking_number_id\": 5,\n \"tracking_number_sid\": \"TPxxxxx\",\n \"tracking_number\": \"+13330004444\",\n \"tracking_label\": \"\",\n \"dial_status\": \"answered\",\n \"is_new_caller\": false,\n \"indexed_at\": 1586793563.8557801,\n \"inbound_rate_center\": {\n \"country\": \"US\",\n \"prefix\": \"1\",\n \"tollfree\": false\n },\n \"billed_amount\": 430.5,\n \"billed_at\": \"2020-04-13T15:29:24\",\n \"caller_number_split\": [\n \"1\",\n \"251\",\n \"286\",\n \"2740\"\n ],\n \"contact_number\": \"+12512862740\",\n \"excluded\": false,\n \"redacted\": false,\n \"tracking_number_format\": \"(333) 000-4444\",\n \"caller_number_format\": \"(251) 286-2740\",\n \"alternative_number\": \"+12512862740\",\n \"caller_number_complete\": \"+12512862740\",\n \"caller_number_bare\": \"2512862740\",\n \"tracking_number_bare\": \"3330004444\",\n \"caller_number\": \"+12512862740\",\n \"visitor\": false,\n \"call_path\": [\n {\n \"route_name\": \"Test\",\n \"route_id\": \"CQxxxxx\",\n \"route_type\": \"CallQueue\",\n \"started_at\": \"2020-04-13T11:28:18Z\"\n }\n ],\n \"left_talk_time\": 0,\n \"right_talk_time\": 0,\n \"transfers\": [],\n \"call_status\": \"answered\",\n \"status\": \"answered\",\n \"spotted\": [],\n \"salesforce\": {},\n \"audio\": \"https://app.calltrackingmetrics.com/api/v1/accounts/1/calls/CAxxxxx/recording\",\n \"callbacks\": [],\n \"emails\": [],\n \"day\": \"Monday\",\n \"month\": \"April\",\n \"hour\": \"11AM\",\n \"ga\": {\n \"cid\": \"1.622\"\n },\n \"tag_list\": [],\n \"notes\": \"\",\n \"latitude\": 39.2847,\n \"longitude\": -76.6205,\n \"extended_lookup_on\": true,\n \"agent_id\": \"USxxxxx\",\n \"agent\": {\n \"name\": \"MOBILE Test Test\",\n \"email\": \"user@test.app\",\n \"id\": \"USxxxxx\"\n },\n \"legs\": [\n {\n \"started_at\": \"2020-04-13T15:28:26Z\",\n \"end_at\": \"2020-04-13T15:29:23Z\",\n \"sid\": \"CAxxxxx\",\n \"to\": null,\n \"from\": \"client:agent_2\",\n \"status\": \"completed\",\n \"tags\": \"\",\n \"pdd_ms\": 38,\n \"direction\": \"inbound\",\n \"disconnected_by\": \"callee\",\n \"from_carrier\": null,\n \"from_connection\": \"twilio_sdk\",\n \"to_carrier\": null,\n \"to_connection\": null,\n \"duration\": 57,\n \"connect_duration\": 57\n },\n {\n \"started_at\": \"2020-04-13T15:28:18Z\",\n \"end_at\": \"2020-04-13T15:29:22Z\",\n \"sid\": \"CAxxxxx\",\n \"to\": \"+13330004444\",\n \"from\": \"+12512862740\",\n \"status\": \"completed\",\n \"tags\": \"\",\n \"pdd_ms\": null,\n \"direction\": \"inbound\",\n \"disconnected_by\": null,\n \"from_carrier\": \"Verizon Wireless\",\n \"from_connection\": \"mobile\",\n \"to_carrier\": \"Twilio\",\n \"to_connection\": \"voip\",\n \"duration\": null,\n \"connect_duration\": 64\n }\n ]\n },\n {\n \"id\": 621,\n \"sid\": \"CAxxxxx\",\n \"account_id\": 12345,\n \"name\": \"Test\",\n \"cnam\": \"User,Test\",\n \"search\": \"\",\n \"referrer\": \"\",\n \"location\": \"\",\n \"source\": \"Website\",\n \"source_id\": 1,\n \"source_sid\": \"TSxxxxx\",\n \"tgid\": 1,\n \"likelihood\": null,\n \"duration\": 66,\n \"direction\": \"inbound\",\n \"talk_time\": 38,\n \"ring_time\": 20,\n \"hold_time\": 8,\n \"wait_time\": 20000,\n \"parent_id\": null,\n \"email\": \"\",\n \"street\": \"\",\n \"city\": \"Severna Park\",\n \"state\": \"MD\",\n \"country\": \"US\",\n \"postal_code\": \"21202\",\n \"called_at\": \"2020-04-13 11:26 AM -04:00\",\n \"unix_time\": 1586791609,\n \"tracking_number_id\": 5,\n \"tracking_number_sid\": \"TPxxxxx\",\n \"tracking_number\": \"+13330004444\",\n \"tracking_label\": \"\",\n \"dial_status\": \"answered\",\n \"is_new_caller\": false,\n \"indexed_at\": 1586793475.8501801,\n \"inbound_rate_center\": {\n \"country\": \"US\",\n \"prefix\": \"1\",\n \"tollfree\": false\n },\n \"billed_amount\": 430.5,\n \"billed_at\": \"2020-04-13T15:27:56\",\n \"caller_number_split\": [\n \"1\",\n \"251\",\n \"286\",\n \"2740\"\n ],\n \"contact_number\": \"+12512862740\",\n \"excluded\": false,\n \"redacted\": false,\n \"tracking_number_format\": \"(333) 000-4444\",\n \"caller_number_format\": \"(251) 286-2740\",\n \"alternative_number\": \"+12512862740\",\n \"caller_number_complete\": \"+12512862740\",\n \"caller_number_bare\": \"2512862740\",\n \"tracking_number_bare\": \"3330004444\",\n \"caller_number\": \"+12512862740\",\n \"visitor\": false,\n \"call_path\": [\n {\n \"route_name\": \"Test\",\n \"route_id\": \"CQxxxxx\",\n \"route_type\": \"CallQueue\",\n \"started_at\": \"2020-04-13T11:26:49Z\"\n }\n ],\n \"left_talk_time\": 0,\n \"right_talk_time\": 0,\n \"transfers\": [],\n \"call_status\": \"answered\",\n \"status\": \"answered\",\n \"spotted\": [],\n \"salesforce\": {},\n \"audio\": \"https://app.calltrackingmetrics.com/api/v1/accounts/1/calls/CAxxxxx/recording\",\n \"callbacks\": [],\n \"emails\": [],\n \"day\": \"Monday\",\n \"month\": \"April\",\n \"hour\": \"11AM\",\n \"ga\": {\n \"cid\": \"1.621\"\n },\n \"tag_list\": [],\n \"notes\": \"\",\n \"latitude\": 39.2847,\n \"longitude\": -76.6205,\n \"extended_lookup_on\": true,\n \"agent_id\": \"USxxxxx\",\n \"agent\": {\n \"name\": \"MOBILE Test Test\",\n \"email\": \"user@test.app\",\n \"id\": \"USxxxxx\"\n },\n \"legs\": [\n {\n \"started_at\": \"2020-04-13T15:27:14Z\",\n \"end_at\": \"2020-04-13T15:27:52Z\",\n \"sid\": \"CAxxxxx\",\n \"to\": null,\n \"from\": \"client:agent_2\",\n \"status\": \"completed\",\n \"tags\": \"\",\n \"pdd_ms\": null,\n \"direction\": \"inbound\",\n \"disconnected_by\": null,\n \"from_carrier\": null,\n \"from_connection\": null,\n \"to_carrier\": null,\n \"to_connection\": null,\n \"duration\": 38,\n \"connect_duration\": 38\n },\n {\n \"started_at\": \"2020-04-13T15:26:49Z\",\n \"end_at\": \"2020-04-13T15:27:55Z\",\n \"sid\": \"CAxxxxx\",\n \"to\": \"+13330004444\",\n \"from\": \"+12512862740\",\n \"status\": \"completed\",\n \"tags\": \"\",\n \"pdd_ms\": 563,\n \"direction\": \"inbound\",\n \"disconnected_by\": \"callee\",\n \"from_carrier\": \"Verizon Wireless\",\n \"from_connection\": \"mobile\",\n \"to_carrier\": \"Twilio\",\n \"to_connection\": \"voip\",\n \"duration\": 65,\n \"connect_duration\": 66\n }\n ]\n },\n {\n \"id\": 620,\n \"sid\": \"CAxxxxx\",\n \"account_id\": 12345,\n \"name\": \"Severna Park, MD\",\n \"cnam\": \"Severna Park, MD\",\n \"search\": \"\",\n \"referrer\": \"\",\n \"location\": \"\",\n \"source\": \"Website\",\n \"source_id\": 1,\n \"source_sid\": \"TSxxxxx\",\n \"tgid\": 1,\n \"likelihood\": null,\n \"duration\": 17,\n \"direction\": \"inbound\",\n \"talk_time\": 0,\n \"ring_time\": 17,\n \"hold_time\": 0,\n \"wait_time\": 11000,\n \"parent_id\": null,\n \"email\": null,\n \"street\": null,\n \"city\": \"\",\n \"state\": \"MD\",\n \"country\": \"US\",\n \"postal_code\": \"\",\n \"called_at\": \"2020-04-13 11:21 AM -04:00\",\n \"unix_time\": 1586791301,\n \"tracking_number_id\": 5,\n \"tracking_number_sid\": \"TPxxxxx\",\n \"tracking_number\": \"+13330004444\",\n \"tracking_label\": \"\",\n \"dial_status\": \"hangup\",\n \"is_new_caller\": false,\n \"indexed_at\": 1586791918.719323,\n \"inbound_rate_center\": {\n \"country\": \"US\",\n \"prefix\": \"1\",\n \"tollfree\": false\n },\n \"billed_amount\": 215.25,\n \"billed_at\": \"2020-04-13T15:21:59\",\n \"caller_number_split\": [\n \"1\",\n \"251\",\n \"915\",\n \"0174\"\n ],\n \"contact_number\": \"+12512862740\",\n \"excluded\": false,\n \"redacted\": false,\n \"tracking_number_format\": \"(333) 000-4444\",\n \"caller_number_format\": \"(251) 915-0174\",\n \"alternative_number\": \"2512862740\",\n \"caller_number_complete\": \"+12512862740\",\n \"caller_number_bare\": \"2512862740\",\n \"tracking_number_bare\": \"3330004444\",\n \"caller_number\": \"+12512862740\",\n \"visitor\": false,\n \"call_path\": [\n {\n \"route_name\": \"Test\",\n \"route_id\": \"CQxxxxx\",\n \"route_type\": \"CallQueue\",\n \"started_at\": \"2020-04-13T11:21:41Z\"\n }\n ],\n \"left_talk_time\": 0,\n \"right_talk_time\": 0,\n \"transfers\": [],\n \"call_status\": \"hangup\",\n \"status\": \"hangup\",\n \"spotted\": [],\n \"salesforce\": {},\n \"callbacks\": [],\n \"emails\": [],\n \"day\": \"Monday\",\n \"month\": \"April\",\n \"hour\": \"11AM\",\n \"ga\": {\n \"cid\": \"1.620\"\n },\n \"tag_list\": [],\n \"latitude\": 38.9525,\n \"longitude\": -76.7012,\n \"extended_lookup_on\": true,\n \"legs\": [\n {\n \"started_at\": \"2020-04-13T15:21:41Z\",\n \"end_at\": \"2020-04-13T15:21:58Z\",\n \"sid\": \"CAxxxxx\",\n \"to\": \"+13330004444\",\n \"from\": \"+12512862740\",\n \"status\": \"completed\",\n \"tags\": \"\",\n \"pdd_ms\": 102,\n \"direction\": \"inbound\",\n \"disconnected_by\": \"caller\",\n \"from_carrier\": \"Verizon Wireless\",\n \"from_connection\": \"mobile\",\n \"to_carrier\": \"Twilio\",\n \"to_connection\": \"voip\",\n \"duration\": 17,\n \"connect_duration\": 17\n }\n ]\n }\n ],\n \"page\": 1,\n \"sort\": [\n {\n \"unix_time\": {\n \"order\": \"desc\",\n \"missing\": \"_last\"\n }\n }\n ],\n \"total_entries\": 616,\n \"total_pages\": 62,\n \"per_page\": 10,\n \"stats\": {},\n \"after\": \"MTxxxxx\",\n \"next_page\": \"https://app.calltrackingmetrics.com/api/v1/accounts/1/calls?after=MTUxxxxx&page=2\"\n}"}],"_postman_id":"2297d53c-bd8e-4c47-91fa-aa4958ef62cb"},{"name":"call transcriptions","event":[{"listen":"test","script":{"id":"a76338b8-2405-45ba-a5d1-a117bed361f5","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","var jsonData = JSON.parse(responseBody);","tests[\"calls is an array\"] = Array.isArray(jsonData.calls);"],"type":"text/javascript"}}],"id":"8c5a93f0-b9d2-46be-9b80-2b7f066631e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{Basic Auth}}"},{"key":"Content-Type","value":"application/json"}],"url":"https://{{host}}/{{base_path}}/accounts/{{account_id}}/calls/{{call_id}}/transcription.json","description":"

Request the transcribed text of a call recording.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
call_id	yes	the call id from the call record

This response from this endpoint includes a link to the call transcription, if available.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
call_id	yes	the call id from the call record
name	no	name of caller
email	no	email of caller
alternative_number	no	alternate number for caller (ex. +14105551212)
street	no	street address of caller
city	no	city from caller address
state	no	state from caller address
country	no	country of caller address
postal_code	no	postal code from caller address
tag_list	no	tags from pre-defined list, comma separated
custom_fields	no	nested object of custom attributes using the api name provided.
triggers	no	by default after each request we'll execute integration and trigger tasks. To disable these side effects pass triggers=0

Example of custom fields:

{ \"custom_fields\": { \"company\": \"Super\", \"userid\": 1881 } }\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
call_id	yes	the call id from the call record
redact_related	no	set to true to redact all calls matching the selected call's phone number

Redaction destroys all personally identifiable information about a contact and cannot be undone. Use extra caution when setting redact_related to true.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
call_id	yes	the call id from the call record
I_Understand_That_This_Can_Not_Be_Reversed	yes	set to 1 to agree that you understand this is irreversible
remove_transcriptions	no	set to 1 to also remove transcriptions for the call if they exist

Removing a call recording permanently destroys the audio recording of a call (and optionally any transcriptions for that call) and cannot be undone.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
call_id	yes	the call id from the call record
I_Understand_That_This_Can_Not_Be_Reversed	yes	set to 1 to agree that you understand this is irreversible

Removing a call transcription permanently destroys the transcription of a call and cannot be undone. If the call audio is still available, the call could still be resubmitted for transcription.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
call_id	yes	the call id from the call record
note	yes	the note/comment to add to a call
user	no	the user to assign to the note. if not specified the user assigned to the call will be used. you can specify the user with either an email address or ctm user id

example bodies

{\n    \"note\": \"hello, world!\",\n    \"user\": \"agent@example.com\"\n}\n\n{\n    \"note\": \"yet another note.\",\n    \"user\": \"USR043E46722529BCB5B49425FB5DC45EAF\"\n}\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
call_id	yes	the call id from the call record
note_id	yes	the note id to update
note	yes	the note/comment to update
user	no	the user to assign to the note. if not specified the user assigned to the call will be used. you can specify the user with either an email address or ctm user id

example bodies

{\n    \"note\": \"hello, world!\",\n    \"note_id\": 46845,\n    \"user\": \"agent@example.com\"\n}\n\n{\n    \"note\": \"yet another note.\",\n    \"note_id\": 46845,\n    \"user\": \"USR043E46722529BCB5B49425FB5DC45EAF\"\n}\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
call_id	yes	the call id from the call record
note_id	yes	the note id to update

example body

{\n    \"note_id\": 46845\n}\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
call_id	yes	the call id from the call record

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
call_id	yes	the call id from the call record
name	no	reporting tag within the call log, typically used as a product name or sales person name
score	no	integer between 1 and 5 to indicate the quality of the call
conversion	no	boolean flag (1 or 0) to indicate whether the call resulted in a sale
value	no	numeric value to represent the total worth of the call in dollars
sale_date	no	date (YYYY-MM-DD) when a sale occurred as a result of this call

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
call_id	yes	the call id from the call record

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
call_id	yes	the call id from the call record

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
id	yes	the call id

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
call_id	yes	the call id from the call record

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
call_id	yes	the call id from the call record

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
call_id	yes	the call id from the call record

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
call_id	yes	the call id
transfer_type	yes	set to: `transfer`
route_to	yes	set to: `number`
to_number	yes	the phone number to which to transfer the call in [E.164](https://en.wikipedia.org/wiki/E.164 Wikipedia) format (i.e. +18885551212 or +441632960162)
message	no	a whisper message to play to the person answering at the `to_number`
sync	no	a flag passing 1 to enable will run the transfer synchronously responding with a transfer object id

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
call_id	yes	the call id
transfer_type	yes	set to: `transfer`
route_to	yes	set to: `agent_id`
agent_id	yes	the USR id of the agent to whom to transfer
message	no	a whisper message to play to the agent
sync	no	a flag passing 1 to enable will run the transfer synchronously responding with a transfer object id

Returns your Do Not Call list

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
agency	no	show the agency do not call list (set to 1, requires agency API keys)

Prevents outgoing calls to a specified number, adding it to your Do Not Call list

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
number	yes	a phone number to add to the do not call list, including country code
agency	no	add to the agency-wide do not call list (set to 1, requires agency API keys)

Remove a number from your Do Not Call list, which will restore the ability to place outgoing calls to that number

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
do_not_call_number	yes	the digits of the phone number (including country code) to delete
agency	no	remove from the agency-wide do not call list, if added agency-wide (set to 1, requires agency API keys)

Returns your Blocked Numbers list

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
agency	no	show the agency blocked numbers list (set to 1, requires agency API keys)

Block a number

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
number	yes	a number in [E.164](https://en.wikipedia.org/wiki/E.164 Wikipedia) format (i.e. +18885551212 or +441632960162)

Unblock a number

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
number	yes	a number in [E.164](https://en.wikipedia.org/wiki/E.164 Wikipedia) format (i.e. +18885551212 or +441632960162)

Block a caller based on a specific call ID

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
call_id	yes	the call id from the call record
agency	no	block caller agency-wide (set to 1)
cnam	no	block calls matching the CNAM associated with the call_id (set to 1; use caution when blocking calls by CNAM! If you block \"Wireless Caller,\" then all calls from all numbers with CNAM \"Wireless Caller\" will be blocked.)
exclude	no	block calls from this number from appearing in call log and reports (set to 1)

Unblock a caller based on a specific call ID

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
call_id	yes	the call id from the call record

Initiate a call via API to connect two people together

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
call_number	yes	the number you want to dial
from_number	yes	the tracking number ID you want to bridge to the call_number on answer
to_agent	no	similar to to_number but dial an agent and when the agent answers bridge the agent to the call_number connecting the two parties.
to_queue	no	similar to to_agent but dial a call queue (1 or more agents dialed) and when an agent answers bridge the agent to the call_number connecting the two parties.
agent_prompt_message	no	\"say:alice:en-US:hello please press 1 to accept the phone call\" - limited to 128 characters (specific to to_agent & to_queue)
agent_prompt_option	no	1 or any - for any keypress (specific to to_agent & to_queue)
route	no	instead of dialing the tracking number configured route use this alternate route
name	no	the name of who you are dialing
user_id	no	the user id to use for the outbound call when bridging to a user via a to_number required if from_number is not assigned to an agent.
send_digits	no	'w1234' will wait 1 second and dial 1234; you can use w to trigger a 1 second pause before entering key press DTMF codes
callerid	no	optionally pass us a verified caller ID in E.164 format e.g. using +1 or +44 to use as the outgoing caller ID presented to the to_number
call_setting	no	Provide a call settings configuration to adjust the greeting message and other call recording / transcription settings associated with the phone call that is started through the API otherwise normally the call setting will be set based on the tracking number used in the from_number.
from_outbound_campaign	no	when selecting the from_number for the outbound dial select a tracking number based on the nearest geographic match to the call_number provided based on the configured outbound campaign. Outbound campaigns can be configured: https://app.calltrackingmetrics.com/outbound_campaigns
autodial	no	automatically trigger an agents softphone to start dialing the given call_number. autodial must be set to browser. e.g. autodial=browser

The from_number tracking number may be configured to dial a call_queue, geo router, another number, sip route, etc.

For the from_number, the tracking number ID can be found in the CTM portal. It is the TPN... string found in the address bar. You can also use the \"list of tracking numbers\" or \"tracking number details\" to lookup a number and find the tracking number ID.

You can also specify the from\\number as a number in E.164 format (i.e. +18885551212).

\n","urlObject":{"protocol":"https","path":["{{base_path}}","accounts","{{account_id}}","calls",""],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"b3d773ef-d93d-4079-8584-2f19f79a69f1"},{"name":"assign agent","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","var jsonData = JSON.parse(responseBody);","tests[\"queued is true\"] = jsonData.queued === true;"]}}],"id":"a57eda1a-e206-4123-825c-e29148eaf065","request":{"method":"POST","header":[{"key":"Authorization","value":"{{Basic Auth}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"status\": \"success\",\n\t\"id\": 1234\n}"},"url":"https://{{host}}/{{base_path}}/accounts/{{account_id}}/agents/{{agent_sid}}/assign_call?call_id={{call_id}}","description":"

Assign an agent to a call. Keep in mind assigning an agent to a call in a queue can result in the call becoming un-answerable.

Remove the assigned agent from the call.

Remove a tag from the record.

Add a tag to the record.

Get a mapping describing the structure of activity records e.g. call, text, chat and forms

Calls have a dynamic list of properties. The properties are dynamic for several reasons.

The list of properties at the beginning of a call is limited. As the call continues and more information becomes available, the list of properties may grow. Even after the call is over, more information may become available from an integration such as Google or Facebook.

Also, depending on the features enabled (SPAM detection, call scoring) or the nature of a call (forwarded to a receiving number, voice menu interaction, delivered to an agent, etc.) different properties may be available.

\n
If you want to easily view JSON in a browser, you will want to install a JSON viewer extension like JSONView for Chrome.
\n

One easy way to get to the JSON object that represents a call is to find a call in the call log, click the \"Detail\" button on the left, and copy the Call ID from the address bar. The call ID will be the number following the \"callid=\" in the address bar URL.

Copy the Call ID, replace everything after the word \"calls\" in the URL with a slash (\"/\"), the Call ID, and \".json\".

For example, if the URL for the call detail is:

\n
calls.example.com/calls#callNav=caller_profile&callId=123456
\n

you would change it to be:

\n
calls.example.com/calls/123456.json
\n

A JSON object with the properties from Call ID will be returned.

\n","event":[{"listen":"prerequest","script":{"id":"29eb9c9d-8065-409e-b1d3-dc46d102ddc6","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c99daa6e-6eed-4793-980a-8c9880d0c7da","type":"text/javascript","exec":[""]}}],"_postman_id":"762e84ed-493c-4e6b-bb3d-38274a55c982","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{access_key}}"},{"key":"password","value":"{{secret_key}}"}]},"isInherited":true,"source":{"_postman_id":"ae3e0dcf-973f-42aa-a1ed-7aa80a35ff97","id":"ae3e0dcf-973f-42aa-a1ed-7aa80a35ff97","name":"CTM API","type":"collection"}}},{"name":"Contact Lists","item":[{"name":"list of contact lists","event":[{"listen":"test","script":{"id":"0e0ef016-e0c3-4b6d-bbbf-ab9fc84c7595","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","var jsonData = JSON.parse(responseBody);","tests.contact_lists = Array.isArray(jsonData.contact_lists);","tests.page = Number.isInteger(jsonData.page);","tests.total_pages = Number.isInteger(jsonData.total_pages);","tests.total_entries = Number.isInteger(jsonData.total_entries);","tests.per_page = Number.isInteger(jsonData.per_page);"],"type":"text/javascript"}}],"id":"f70d633f-13ac-4051-bb93-f36988fa4cea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{Basic Auth}}"},{"key":"Content-Type","value":"application/json"}],"url":"https://{{host}}/{{base_path}}/accounts/{{account_id}}/lists","description":"

gets list of contact lists, including name and description

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id

gets detailed information about a contact list including number of contacts

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
list_id	yes	the list id

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account	yes	the account id
contact_list[name]	yes	a name for the contact list
contact_list[description]	no	a descriptor for the contact list

JSON body example

{\n    \"contact_list\": {\n        \"name\" : \"Marketing List\",\n        \"description\" : \"List of contacts for marketing\"\n    }\n}\n

\n
Note that list names are not required to be unique.
\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account	yes	the account id
contact_list_id	yes	the contact list id
contact_list[name]	yes	a name for the contact list
contact_list[description]	no	a descriptor for the contact list

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account	yes	the account id
contact_list_id	yes	the contact list id

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account	yes	the account id
contact_list_id	yes	the contact list id

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account	yes	the account id
contact_list_id	yes	the contact list id
phone_number	yes	the phone number of the contact to check, be sure to include the country code in your phone number use E.164 formatted numbers

Using this method in the context of a lambda function

  const apiCall = `lists/${listId}/contains?phone_number=${call.caller_number.replace(/\\D/g,'')}`\n  const http = await context.ctm.api_get(apiCall);\n  if (http.response.statusCode == 204) {\n     context.done(null, {say: \"A message to play when routing the caller to ivr2.\",\n                         route: ivr2})\n  } else {\n    console.log(\"we did not find you\");\n    context.done(null, {say: \"A message to play to the caller when they are not on the list\",\n                        route: ivr1})\n  }\n\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account	yes	the account id
contact_list_id	yes	the contact list id
contact[number]	yes	number for contact in e.164
contact[first_name]	no	contact's first name
contact[last_name]	no	contact's last name
contact[email]	no	contact's email
contact[street]	no	includes street number
contact[city]	no	contact's city
contact[state]	no	contact's state
contact[country]	no	contate's country
contact[postal_code]	no	contact's postal code
contact[custom_api_name]	no	a value for any custom field

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account	yes	the account id
contact_list_id	yes	the contact list id
contacts_list	yes	array of contact numbers in e.164 format

removes all of the contacts in a give contact list but retains the contact list

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account	yes	the account id
contact_list_id	yes	the contact list id

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id

To edit the custom fields on a particular call, see Calls - Modify Call Details.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
custom_field_id	yes	the custom field's id

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
custom_panel_id	yes	the custom panel's id

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id

Responds with status and (if status is success) array of panel IDs and array of field IDs.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
custom_field_id	yes	the custom field id
options	yes	a string containing line-feed (\\n) delineated list of fields

options may optionally specify an internal name using ':' separators (value:label) such as: \"Option 1:option1\\nOption 2:option2\\nOption 3:option3\"

Responds with status and (if status is success) the new custom field with similar output.

Create a single custom field by posting the details to this endpoint.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Description
name	name of the custom field (for users to read)
api_name	should be alpha numeric and underscores only. should be only lower case characters.
field_type	can be anyone of the following types: number float text date email url phone picker bool rating duration country region textarea geo
required	can be \"yes\", \"on\" or \"1\" - to indicate whether the custom field is required in the context of the panel it's included in.
log_visible	can be \"yes\", \"on\" or \"1\" - to indicate whether the custom field is visible within the call log without loading the specific panel its included within.
multipicker	when using the field_type: \"picker\" this allows a user to select multiple values. should be either \"yes\", \"on\" or \"1\" to enable
object_type	Can be one of Call Contact TrackingNumber Call indicates this is an Activity level custom field that will have a unique value for each activity record e.g. phone call in the logs. Contact indicates it'll be shared value so any activity that involves the same contact will share this value. TrackingNumber allows you to assign a value to a tracking number and any value on that custom field will be exposed to the activities.
panel	contact or score

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
filter	no	search string for dialer name/description
page	no	the page number
per_page	no	the number of items per page, defaults to 10

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
dialer_id	yes	the dialer id

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
dialer_id	yes	the dialer id

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
dialer_id	yes	the dialer id

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
dialer_id	yes	the dialer id
I_Accept_Outbound_Call_and_Text_Compliance	yes	needs to be set to true or the dialer will not be started

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
dialer_mode	yes	the dialer mode either progressive or predictive
name	yes	name of your dialer
description	no	description text for your dialer
min_required_agents	no	defaults to 1
call_queue_id	no	required for progressive dialer but not for predictive
contact_list_id	no	You can push a contact list to the dialer instead of a list of phone numbers.

Example:

{
\"id\": \"DIL0131BF8D9BEF37FA5F2729814AC1D724\",
\"name\": \"Test Dialer\",
\"description\": \"super test\",
\"dialer_mode\": \"progressive\",
\"min_required_agents\": 2,
\"call_queue_id\": 72,
\"tag_list\": \"\",
\"callerid_mode\": \"best\",
\"outbound_callerid\": \"67262\",
\"best_match_team_id\": 1,
\"premium_lookup\": false,
\"restrict_by_time\": false,
\"start_time\": \"07:00 am\",
\"end_time\": \"11:00pm\",
\"prompt_agents\": true,
\"greeting_for_agent\": \"say:alice:en-US:\",
\"schedule_id\": null,
\"machine_check\": false,
\"post_call_confirmation\": true,
\"post_call_phone_prompt\": \"Did you connect?\",
\"post_call_phone_prompt_action\": \"Yes Connected\",
\"transfer_confirmation\": false,
\"call_duration_confirmation\": false,
\"call_duration_threshold\": 10,
\"default_action_label\": null,
\"default_action_id\": 1524,
\"default_action_type\": \"VoiceMenu\",
\"max_dial_rate\": 1,
\"max_dials_to_agent\": 20,
\"broadcast\": true,
\"dial_order\": \"lifo\",
\"call_keypress_confirmation\": \"1\",
\"dialer_broad_cast_rate\": \"fast\",
\"dialer_start_at\": null,
\"dialer_end_at\": null,
\"use_keypress_confirmation\": false,
\"consider_callback_a_success\": false, \"contact_list_id\": \"contact list id\",
\"dial_plans\": [
{
\"id\": 949,
\"callback_minutes\": 0,
\"is_sms\": false,
\"sms_message\": \"\"
}
]
}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
dialer_mode	yes	the dialer mode either progressive or predictive
name	yes	name of your dialer
description	no	description text for your dialer
min_required_agents	no	defaults to 1
call_queue_id	no	required for progressive dialer but not for predictive
contact_list_id	no	optionally send a contact list id and we'll populate the number list in the dialer from the list.

Example:

{
\"id\": \"DIL0131BF8D9BEF37FA5F2729814AC1D724\",
\"name\": \"Test Dialer\",
\"description\": \"super test\",
\"dialer_mode\": \"progressive\",
\"min_required_agents\": 2,
\"call_queue_id\": 72,
\"tag_list\": \"\",
\"callerid_mode\": \"best\",
\"outbound_callerid\": \"67262\",
\"best_match_team_id\": 1,
\"premium_lookup\": false,
\"restrict_by_time\": false,
\"start_time\": \"07:00 am\",
\"end_time\": \"11:00pm\",
\"prompt_agents\": true,
\"greeting_for_agent\": \"say:alice:en-US:\",
\"schedule_id\": null,
\"machine_check\": false,
\"post_call_confirmation\": true,
\"post_call_phone_prompt\": \"Did you connect?\",
\"post_call_phone_prompt_action\": \"Yes Connected\",
\"transfer_confirmation\": false,
\"call_duration_confirmation\": false,
\"call_duration_threshold\": 10,
\"default_action_label\": null,
\"default_action_id\": 1524,
\"default_action_type\": \"VoiceMenu\",
\"max_dial_rate\": 1,
\"max_dials_to_agent\": 20,
\"broadcast\": true,
\"dial_order\": \"lifo\",
\"call_keypress_confirmation\": \"1\",
\"dialer_broad_cast_rate\": \"fast\",
\"dialer_start_at\": null,
\"dialer_end_at\": null,
\"use_keypress_confirmation\": false,
\"consider_callback_a_success\": false,\"contact_list_id\": \"a contact list id\",
\"dial_plans\": [
{
\"id\": 949,
\"callback_minutes\": 0,
\"is_sms\": false,
\"sms_message\": \"\"
}
]
}

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
dialer_id	yes	the dialer id

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
dialer_id	yes	the auto dialer id
numbers_list	yes	an array of phone numbers to dial in E.164 format
I_Accept_Outbound_Call_and_Text_Compliance	yes	needs to be set to true or numbers will not be added
new_only	no	set to 1 to perform an upsert operation: dialer stats will not be reset if you add a number again

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
dialer_id	yes	the dialer id
numbers_list	yes	an array of numbers in E.164 format that should be removed from the auto dialer

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
dialer_id	yes	the dialer id

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
number	yes	E.164 formatted phone number. You may need to ensure the + in the phone number is encoded e.g. '+' must be CGI or URI encoded.

get list of divisions

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments

get a divisions list of accounts

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes
division_id	yes

get a divisions list of users

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes
division_id	yes

get a divisions list of admins

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes
division_id	yes

FormReactors may be used through other form systems using our API (managed mode). When operating in managed mode, the specific form fields are managed by your third party system. The form data sent through this endpoint automatically creates a new FormReactor (based on the {unique_form_id}) and adds the form submission in your account's call log. You can then use the created FormReactor to configure how to react to new form submissions through the same {unique_form_id}. We limit the total number of unique API-based FormReactors to 1000 per account on the Growth and Connect plans and 100 for Performance plans.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
unique_form_id	yes	a unique ID to identify your form. One FormReactor's will be created for each unique ID. When using a user provider unique form id be sure to additionally pass the type parameter with the value API
caller_name	no	caller's name
country_code	no	phone number's country code (numeric)
phone_number	yes	phone number (i.e. 8885551212)
email	no	email address
visitor_sid	no	the visitor id
callback_number	no	the callback number, is a tracking number and used as the callerid when dialing a receiving number
receiving_number	no	optionally use to modify the receiving number dialed when dialing a receiving number first. An E.164 number that also exists as a receiving number in CTM
delay_calling_by	no	optionally delay the form reactor from triggering any events by passing a value in minutes that is between 1 minute and 60 days.
custom_field	no	custom field (each custom field id is prefixed with \"custom_\") e.g. The custom field 'color' would be sent as custom_color or if you prefer british english custom_colour, but lets be real color is easier.

Accept the consent for form reactor submission

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
email	yes	this should be the email of the agency owner

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
filter	no	a filter to use for searching by name

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
geo_route_id	yes	the geo router id

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
geo_config_id	yes	the geo router id
name	yes	set to: `transfer`
play_message	yes	a voice message or audio recording to playback e.g. say: .. play:...
route_by	yes	how to route either 'zipcode' or 'areacode'

You can use the batch geo processing interface to easily setup a large geo router using a simple command based interface to

add, update and remove receiving numbers from your geo router.

curl -XPUT-uAPI:SEC --upload-file commands.txt \\\nhttps://api.calltrackingmetrics.com/api/v1/accounts/{account_id}/geo_routes/{geo_router_id}/batch\n

example commands.txt

create +15555553232 todd cell phone\nupdate +15555553232 updated phone label\naddzip +15555553232 21146 21144\ndelzip +15555553232 21144\nclearzips +15555553232\nremove +15555553232\nmark   +15555553232\npurge log\n

The following options can be included in your request URL to adjust how we process each command

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
global	no	when passed as 1 - we will treat receiving numbers as global to your account instead of scoping to the geo router.
create	no	when passed as 1 - will always create a new receiving number, otherwise create will actually just operate like update. The default 0 is usually what you want

Adding a post_back_url or a post_back_email will trigger a web service POST request to the post_back_url, that will include the resulting status of the transaction of batched commands.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

command	description
create	find or create the number associating it to the geo router
update	update the provided numbers label
addzip	add one or more zip codes to the provided number
delzip	delete one or more zip codes from the provided number
clearzips	remove all associated zipcode data from the provided number
remove	remove the provided number from the given geo router
mark	mark this number so it is not purged
purge	purge will remove, delete or log to indicate which numbers were not marked that exist within the geo router

Mark and Purge

Mark and Purge work together allowing you to indicate the numbers you want to retain\nby calling mark (number)\nand at the end of your file calling purge will remove any non-marked numbers from the geo router

mark number - marks this number to keep it any number not marked will be eligible for purge

purge remove - removes the number but does not delete it from your geo router

purge delete - deletes the number and removes it from your geo router

purge log - logs the number we would delete log will include purge_list in the post_back_url request json data

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
name	yes	set to: `transfer`
play_message	yes	a voice message or audio recording to playback e.g. say: .. play:...
route_by	yes	how to route either 'zipcode' or 'areacode'
default_state	yes	how to route incoming callers either prompt, number or always. number will never prompt, so make sure the default is configured. always will always prompt. prompt will conditionally prompt when no data on the incoming caller is available.
retry_prompt_count	no	how many times should we reprompt when prompting. e.g. 1 or 2 times
input_verify	no	boolean value to indicate whether we should prompt the caller to verify their input.
default_route_to	no	if we do not have a valid location or we have no geo data to route by and we did not get a valid prompt entry - where should we route the incoming caller? Options: hangup, receiving_number, voice_menu. When choosing receiving_number or voice_menu see the default_number_id and voice_menu_id respectively.
voice_menu_id	no	a default voice menu to route callers to without geo data.
default_number_id	no	a default receiving number to route callers to without geo data.
multi_route_preference	no	simultaneous, round robin, or sequential - this option allows you to specify how we should handle routing to a geo graphic location that has multiple overlapping receiving numbers. The default is simultaneous. round robin will alternate the starting number based on the previous call. sequential works like round robin but instead of locking to a single receiving number will cascade to the other set of numbers automatically after 9 seconds of ringing.
default_match_radius	no	default 100 miles. This is a match radius if we do not have an exact match we can do a geo graphic distance calculation to select the nearest numbers to the given location.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
geo_route_id	yes	the geo router id
ppn_id	yes	the ppn_id of the phone number

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
geo_route_id	yes	the geo router id
ppn_id	yes	the ppn_id of the phone number

Geo Routers allow you configure massive number of receiving numbers and map them to multiple area codes or multiple zip codes.

\n","_postman_id":"8f34ed8f-9040-4c32-8f06-87af7cddd7bb","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{access_key}}"},{"key":"password","value":"{{secret_key}}"}]},"isInherited":true,"source":{"_postman_id":"ae3e0dcf-973f-42aa-a1ed-7aa80a35ff97","id":"ae3e0dcf-973f-42aa-a1ed-7aa80a35ff97","name":"CTM API","type":"collection"}}},{"name":"Google Analytics","item":[{"name":"google analytics link information","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","var jsonData = JSON.parse(responseBody);","tests[\"linked is boolean\"] = typeof jsonData.linked === \"boolean\";","tests[\"status is non-empty string\"] = (typeof jsonData.status === \"string\") && (jsonData.status.length > 0);"]}}],"id":"1b5cc51b-7089-402d-a89a-2c8a976d703b","request":{"method":"GET","header":[{"key":"Authorization","value":"{{Basic Auth}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{host}}/{{base_path}}/accounts/{{account_id}}/ga/link","description":"

requires agency api access

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id

requires agency api access

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameters	Required	Description
account_id	yes	the account id
call_id	yes	the call id
ga_category	no	the Google Analytics category
ga_action	no	the Google Analytics action
ga_label	no	the Google Analytics label
ga_value	no	the Google Analytics value
uacode	no	the Google Analytics tracking id

Introduction

This API allows you to send a tracking event to our analytics service. Doing this allows you to track that a visitor has seen a given number. It also allows you to attach custom variables to website visitors for additional third party tracking tools.

Tracking Ready Event

When loading our JavaScript, you may need to know when it’s ready to interact with. This can be done by attaching a __ctm_loaded method.

Event Tracking

These functions should be invoked within the CTMSourceEvent callback.

__ctm.tracker.trackVisitor(\"dddddddddd\", \"eeeeeeeeee\");\n

This function should only be called once per page, and can be useful to call when swapping images on a page to ensure we track the visitor.

__ctm.tracker.trackEvent(\"dddddddddd\", \"eeeeeeeeee\", \"visible\");\n

This function can be called multiple times per page, and is useful for indicating whether the number was visible to the visitor or whether the number clicked on by the visitor.

FormReactor Events

After a form is submitted within FormReactor there are a number of events you can subscribe to. The events are available when using the embeddable FormReactor widget.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
ctm.form.success	trigger after a form is successfully submitted to a CTM server
ctm.form.limited	trigger when a customer was rate limited e.g. has already or recently submitted the form successfully
ctm.form.error	trigger when a customer has an error with their submission; see `evt.fields` for a list of fields that are not valid
ctm.form.failure	trigger when a CTM server fails to handle the submission successfully

To use the Form Events you can subscribe via the global __jctm, a wrapper object for jQuery.

__jctm(window).bind(\"ctm.form.success\", function(evt) { \n  console.log(evt);\n});\n

The example above, will trigger the callback whenever the embedded widget is successfully filled out. This gives you the option to customize what happens after someone fills out the form. One option here is to add a conversion tracking pixel or other customized post form fill actions.

\n","_postman_id":"978fdd9d-85bd-4f0d-abfe-4c0e67d5b4ce","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{access_key}}"},{"key":"password","value":"{{secret_key}}"}]},"isInherited":true,"source":{"_postman_id":"ae3e0dcf-973f-42aa-a1ed-7aa80a35ff97","id":"ae3e0dcf-973f-42aa-a1ed-7aa80a35ff97","name":"CTM API","type":"collection"}}},{"name":"Javascript Images API","item":[],"id":"0583fe8e-825c-463b-b965-731e5b0042c5","description":"

Replacing Images

To replace an image with a phone number, all you need is to hook into the CTMSourceEvent function. Locate the image you want to replace, either by adding a class or ID attribute. If you have a library such as jQuery this is fairly easy but will also work with native DOM functions.

You do not need to update your embedded code; you can add all of this code within account settings.

The example assumes you have an image element with the ID attribute yournumber. It has a mapping table that associates each tracking number to a specific CallTrackingMetrics tracking number.

// javascript within account settings - tracking script\nwindow.CTMSourceEvent = function(event) {\n  if (event.state != 'before') { return; }\n  var numberMap = {\n    \"4103949424\": \"/images/samples/ctm-logo-4103949424.png\", // direct visits\n    \"4106954857\": \"/images/samples/ctm-logo-4106954857.png\"  // this demo\n  }\n  var swapNumber = numberMap[event.new_number]\n  if (swapNumber) {\n    document.getElementById(\"yournumber\").src = swapNumber;\n  }\n}\n

\n","_postman_id":"0583fe8e-825c-463b-b965-731e5b0042c5","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{access_key}}"},{"key":"password","value":"{{secret_key}}"}]},"isInherited":true,"source":{"_postman_id":"ae3e0dcf-973f-42aa-a1ed-7aa80a35ff97","id":"ae3e0dcf-973f-42aa-a1ed-7aa80a35ff97","name":"CTM API","type":"collection"}}},{"name":"Javascript Tracking API","item":[],"id":"5fb5ebb3-a182-4ace-9621-19055baecc05","description":"

Introduction

This section of the documentation describes the interface to our client side JavaScript API. With this API you can dynamically update images based on the chosen tracking number for the current visitor. You can adjust phone number formats, set custom variables and more.

Tracking Code

Be sure to have our tracking code installed on each page of your website. Even if the phone number is not found on the page, it’s important because we use cookies in order to preserve the visitor's first touch source. This ensures we always show each website visitor a consistent phone number.

Callback API

The primary interface to our client side code is through a global call back function, CTMSourceEvent. This function will be invoked to signal different events or stages of the number replacement and tracking process.

As the tracking code works to locate and update phone numbers automatically, it will call this method before replacing a number and after replacing a number. This will allow you to 'hook’ into the number replacement flow, such that you can manipulate the output format, identify which phone number was selected for tracking, and other customizations.

For example, the following CTMSourceEvent function could be defined within the account settings dashboard under “tracking script” in order to add an additional DOM element under the update phone number.

window.CTMSourceEvent = function(event) {\n  if (event.state == 'after') {\n    // update DOM after number replacement\n  }\n}\n

The event object passed to this method includes the following attributes:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Description
event.state	`before`: event is fired before the number swap algorithm is run against your web page DOM tree `after`: event is fired after our number swap algorithm is run against your web page DOM tree `node:before`: event is fired before the number swap is run on a specific element on the web page. `node:after`: event is fired after the number swap is run on a specific element on the web page.
event.current_number	current number found in your website’s DOM tree; this number is the receiving number that was present on your website before any tracking code is executed
event.new_number	the new number that will replace the current_number; this number is the tracking number that will be present after tracking code is executed
event.node	this attribute is included when the callback is triggered by the `node:before` and the `node:after` events

Custom Variables

You can assign custom variables to each visitor tracked by initializing a variable __ctm_cvars. Set the variables before loading the embed code. For example:

var __ctm_cvars = __ctm_cvars || [];\n__ctm_cvars.push({uservar1: 'test'});\n

The value that you push into the Array can be either a String or an Object. When the value is an Object, it will be serialized to JSON before being stored with the visitor.

Conversion Tracking

To track form conversions back to calls, CallTrackingMetrics provides an interface to record information about the form conversion such as the phone number, email and value of the conversion. The global variable __ctmi is used to track conversions. See the example:

var __ctmi = __ctmi || [];\n(window.__ctm_loaded || []).push(function() {\n__ctmi.push(['form.conversion', \"+15555555555\", \"address@example.com\", 282.28]);\n});\n

The first argument tells __ctmi you want to track a form conversion. The next arguments are some information about the form entry that allows us to better match each form entry to a previous caller. The last argument after the phone number and email arguments is the value of the conversion.

Setting it up:

To setup the conversions tracking code above, you should place it on the thank you or confirmation page of your form.

Here are some examples of how you could retrieve the values to track in the CTM conversion code:

PHP

<script>\nvar __ctmi = __ctmi || [];\n(window.__ctm_loaded || []).push(function() {\n__ctmi.push([\"form.conversion\", \"<?php echo $number ?>\",\"<?php echo $email ?>\"]);\n});\n</script>\n

Ruby

<script>\nvar __ctmi = __ctmi || [];\n(window.__ctm_loaded || []).push(function() {\n__ctmi.push([\"form.conversion\", \"<%= number %>\",\"<%= email %>\"]);\n});\n</script>\n

Preventing Number Swapping

In some cases, you will have the phone number on the page but you will not want us to replace it. To support this case, you can add a class name around the parent DOM Element ctm-no-swap. For example:

<p class=\"ctm-no-swap\">(555) 555-5555</p>\n

You may also set the variable:

__ctm.no_swap=true;\n

If for example, you have a cookie and want to conditionally disable tracking based on the cookie you would do the following:

window.CTMSourceEvent = function(event) {\n   var cookie = document.cookie;\n   if (cookie.match(/disable_ctm=1/)) {\n      __ctm.no_swap=true;\n   }\n   }\n}\n

\n","_postman_id":"5fb5ebb3-a182-4ace-9621-19055baecc05","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{access_key}}"},{"key":"password","value":"{{secret_key}}"}]},"isInherited":true,"source":{"_postman_id":"ae3e0dcf-973f-42aa-a1ed-7aa80a35ff97","id":"ae3e0dcf-973f-42aa-a1ed-7aa80a35ff97","name":"CTM API","type":"collection"}}},{"name":"Numbers | Address","item":[{"name":"list of addresses","event":[{"listen":"test","script":{"id":"532ec661-d872-465c-b67d-3d59b2d38d0f","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","var jsonData = JSON.parse(responseBody);","tests[\"return value is an array\"] = Array.isArray(jsonData);"],"type":"text/javascript"}}],"id":"af4b4e9c-dd6c-49af-824e-a25fabbc63eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{Basic Auth}}"},{"key":"Content-Type","value":"application/json"}],"url":"https://{{host}}/{{base_path}}/accounts/{{account_id}}/number_address/","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id

The returned addresses will include a sid field that can be used with other address API endpoints.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
name	no	the business name (defaults to agency name)
street	yes	street portion of the address
city	yes	city portion of the address
region	yes	region portion of the address
postal_code	yes	postal code for the address
country	yes	name or ISO code (UK, DE, etc) of the country

The returned address will include a sid field that can be used with other address API endpoints.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
address_sid	yes	the address sid (AD_________) as provided by the list/create endpoints

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
tracking_number_id	yes	the TPN tracking number ID

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
tracking_number_id	yes	the TPN tracking number ID
address_sid	yes	the AD address ID to associate with the number

Many non-US/CA tracking numbers are required to be linked to a physical address.

\n","event":[{"listen":"prerequest","script":{"id":"02fdf605-6ab0-4568-9a5f-f539a8975731","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"5333a3c3-4dc4-4c7e-b20d-652a638d74a6","type":"text/javascript","exec":[""]}}],"_postman_id":"3fd9ea2f-f1c2-45dc-b906-3b851c75782e","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{access_key}}"},{"key":"password","value":"{{secret_key}}"}]},"isInherited":true,"source":{"_postman_id":"ae3e0dcf-973f-42aa-a1ed-7aa80a35ff97","id":"ae3e0dcf-973f-42aa-a1ed-7aa80a35ff97","name":"CTM API","type":"collection"}}},{"name":"Numbers | Purchase","item":[{"name":"search for US/CA numbers","event":[{"listen":"test","script":{"id":"5760fa84-d937-47b0-8f7c-b6bdb13d7392","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","var jsonData = JSON.parse(responseBody);","tests[\"numbers is an array\"] = Array.isArray(jsonData.numbers);","tests[\"country is two chars\"] = jsonData.country.length === 2;","tests[\"status is success\"] = jsonData.status === \"success\";"],"type":"text/javascript"}}],"id":"f6759000-dded-4a48-9c95-24158d775cbf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{Basic Auth}}"},{"key":"Content-Type","value":"application/json"}],"url":"https://{{host}}/{{base_path}}/accounts/{{account_id}}/numbers/search.json?country=US&searchby=area&areacode=443","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
country	yes	the ISO_3166-1_alpha-2 two-letter country code
searchby	yes	one of `area`, `tollfree`, `address`, or `number`
area_code	no	if using `searchby` set to `area` specify an area code to search for numbers in
pattern	no	an optional pattern to search for
address	no	if using `searchby` set to `address` specify an address or zip code: `123 main street, new york, ny` or `10001`
number	no	if using `searchby` set to `number` specify an area code and prefix: `917563`

","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{access_key}}"},{"key":"password","value":"{{secret_key}}"}]},"isInherited":true,"source":{"_postman_id":"ae3e0dcf-973f-42aa-a1ed-7aa80a35ff97","id":"ae3e0dcf-973f-42aa-a1ed-7aa80a35ff97","name":"CTM API","type":"collection"}},"urlObject":{"protocol":"https","path":["{{base_path}}","accounts","{{account_id}}","numbers","search.json"],"host":["{{host}}"],"query":[{"key":"country","value":"US"},{"key":"searchby","value":"area"},{"key":"areacode","value":"443"}],"variable":[]}},"response":[{"id":"df91c7fc-f21a-438a-9ef5-b5db6c0244b5","name":"search for US/CA numbers","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{Basic Auth}}"},{"key":"Content-Type","value":"application/json"}],"url":{"raw":"https://{{host}}/{{base_path}}/accounts/{{account_id}}/numbers/search.json?country=US&searchby=area&areacode=443","protocol":"https","host":["{{host}}"],"path":["{{base_path}}","accounts","{{account_id}}","numbers","search.json"],"query":[{"key":"country","value":"US"},{"key":"searchby","value":"area"},{"key":"areacode","value":"443"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"openresty/1.19.3.1","enabled":true},{"key":"Date","value":"Mon, 08 Feb 2021 20:13:29 GMT","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Transfer-Encoding","value":"chunked","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"X-Frame-Options","value":"SAMEORIGIN","enabled":true},{"key":"X-XSS-Protection","value":"1; mode=block","enabled":true},{"key":"X-Content-Type-Options","value":"nosniff","enabled":true},{"key":"X-Download-Options","value":"noopen","enabled":true},{"key":"X-Permitted-Cross-Domain-Policies","value":"none","enabled":true},{"key":"Referrer-Policy","value":"strict-origin-when-cross-origin","enabled":true},{"key":"ETag","value":"W/\"d657ba1c0a361d2627f3f32ae520950a\"","enabled":true},{"key":"Cache-Control","value":"max-age=0, private, must-revalidate","enabled":true},{"key":"X-Request-Id","value":"0f393d1f-def7-4dc6-b9ef-7b778f90935d","enabled":true},{"key":"X-Runtime","value":"0.758451","enabled":true},{"key":"Content-Encoding","value":"gzip","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"numbers\": [\n {\n \"friendly_name\": \"+1 (443) 342-2893\",\n \"latitude\": \"38.334600\",\n \"longitude\": \"-76.468100\",\n \"lata\": \"238\",\n \"region\": \"MD\",\n \"postal_code\": \"20688\",\n \"iso_country\": \"US\",\n \"capabilities\": {\n \"voice\": true,\n \"SMS\": true,\n \"MMS\": true\n },\n \"number\": \"+14433422893\",\n \"phone_number\": \"+14433422893\",\n \"number_type\": \"local\",\n \"addr_required\": \"none\",\n \"hipaa_friendly\": true,\n \"ratecenter\": \"\",\n \"source\": 1\n },\n {\n \"friendly_name\": \"+1 (443) 342-9453\",\n \"latitude\": \"38.334600\",\n \"longitude\": \"-76.468100\",\n \"lata\": \"238\",\n \"region\": \"MD\",\n \"postal_code\": \"20688\",\n \"iso_country\": \"US\",\n \"capabilities\": {\n \"voice\": true,\n \"SMS\": true,\n \"MMS\": true\n },\n \"number\": \"+14433429453\",\n \"phone_number\": \"+14433429453\",\n \"number_type\": \"local\",\n \"addr_required\": \"none\",\n \"hipaa_friendly\": true,\n \"ratecenter\": \"\",\n \"source\": 1\n },\n {\n \"friendly_name\": \"+1 (443) 323-2321\",\n \"latitude\": \"38.542600\",\n \"longitude\": \"-75.719400\",\n \"lata\": \"242\",\n \"region\": \"MD\",\n \"postal_code\": \"21861\",\n \"iso_country\": \"US\",\n \"capabilities\": {\n \"voice\": true,\n \"SMS\": true,\n \"MMS\": true\n },\n \"number\": \"+14433232321\",\n \"phone_number\": \"+14433232321\",\n \"number_type\": \"local\",\n \"addr_required\": \"none\",\n \"hipaa_friendly\": true,\n \"ratecenter\": \"\",\n \"source\": 1\n },\n {\n \"friendly_name\": \"+1 (443) 323-1609\",\n \"latitude\": \"38.542600\",\n \"longitude\": \"-75.719400\",\n \"lata\": \"242\",\n \"region\": \"MD\",\n \"postal_code\": \"21861\",\n \"iso_country\": \"US\",\n \"capabilities\": {\n \"voice\": true,\n \"SMS\": true,\n \"MMS\": true\n },\n \"number\": \"+14433231609\",\n \"phone_number\": \"+14433231609\",\n \"number_type\": \"local\",\n \"addr_required\": \"none\",\n \"hipaa_friendly\": true,\n \"ratecenter\": \"\",\n \"source\": 1\n },\n {\n \"friendly_name\": \"+1 (443) 342-9519\",\n \"latitude\": \"38.334600\",\n \"longitude\": \"-76.468100\",\n \"lata\": \"238\",\n \"region\": \"MD\",\n \"postal_code\": \"20688\",\n \"iso_country\": \"US\",\n \"capabilities\": {\n \"voice\": true,\n \"SMS\": true,\n \"MMS\": true\n },\n \"number\": \"+14433429519\",\n \"phone_number\": \"+14433429519\",\n \"number_type\": \"local\",\n \"addr_required\": \"none\",\n \"hipaa_friendly\": true,\n \"ratecenter\": \"\",\n \"source\": 1\n },\n {\n \"friendly_name\": \"+1 (443) 323-0556\",\n \"latitude\": \"38.542600\",\n \"longitude\": \"-75.719400\",\n \"lata\": \"242\",\n \"region\": \"MD\",\n \"postal_code\": \"21861\",\n \"iso_country\": \"US\",\n \"capabilities\": {\n \"voice\": true,\n \"SMS\": true,\n \"MMS\": true\n },\n \"number\": \"+14433230556\",\n \"phone_number\": \"+14433230556\",\n \"number_type\": \"local\",\n \"addr_required\": \"none\",\n \"hipaa_friendly\": true,\n \"ratecenter\": \"\",\n \"source\": 1\n },\n {\n \"friendly_name\": \"+1 (443) 222-0328\",\n \"latitude\": \"39.460110\",\n \"longitude\": \"-76.753860\",\n \"lata\": \"238\",\n \"region\": \"MD\",\n \"postal_code\": \"\",\n \"iso_country\": \"US\",\n \"capabilities\": {\n \"voice\": true,\n \"SMS\": true,\n \"MMS\": true\n },\n \"number\": \"+14432220328\",\n \"phone_number\": \"+14432220328\",\n \"number_type\": \"local\",\n \"addr_required\": \"none\",\n \"hipaa_friendly\": true,\n \"ratecenter\": \"\",\n \"source\": 1\n },\n {\n \"friendly_name\": \"+1 (443) 342-9501\",\n \"latitude\": \"38.334600\",\n \"longitude\": \"-76.468100\",\n \"lata\": \"238\",\n \"region\": \"MD\",\n \"postal_code\": \"20688\",\n \"iso_country\": \"US\",\n \"capabilities\": {\n \"voice\": true,\n \"SMS\": true,\n \"MMS\": true\n },\n \"number\": \"+14433429501\",\n \"phone_number\": \"+14433429501\",\n \"number_type\": \"local\",\n \"addr_required\": \"none\",\n \"hipaa_friendly\": true,\n \"ratecenter\": \"\",\n \"source\": 1\n },\n {\n \"friendly_name\": \"+1 (443) 342-9518\",\n \"latitude\": \"38.320000\",\n \"longitude\": \"-76.450000\",\n \"lata\": \"238\",\n \"region\": \"MD\",\n \"postal_code\": \"20688\",\n \"iso_country\": \"US\",\n \"capabilities\": {\n \"voice\": true,\n \"SMS\": true,\n \"MMS\": true\n },\n \"number\": \"+14433429518\",\n \"phone_number\": \"+14433429518\",\n \"number_type\": \"local\",\n \"addr_required\": \"none\",\n \"hipaa_friendly\": true,\n \"ratecenter\": \"\",\n \"source\": 1\n },\n {\n \"friendly_name\": \"+1 (443) 342-9572\",\n \"latitude\": \"38.320000\",\n \"longitude\": \"-76.450000\",\n \"lata\": \"238\",\n \"region\": \"MD\",\n \"postal_code\": \"20688\",\n \"iso_country\": \"US\",\n \"capabilities\": {\n \"voice\": true,\n \"SMS\": true,\n \"MMS\": true\n },\n \"number\": \"+14433429572\",\n \"phone_number\": \"+14433429572\",\n \"number_type\": \"local\",\n \"addr_required\": \"none\",\n \"hipaa_friendly\": true,\n \"ratecenter\": \"\",\n \"source\": 1\n },\n {\n \"friendly_name\": \"+1 (443) 342-9313\",\n \"latitude\": \"38.334600\",\n \"longitude\": \"-76.468100\",\n \"lata\": \"238\",\n \"region\": \"MD\",\n \"postal_code\": \"20688\",\n \"iso_country\": \"US\",\n \"capabilities\": {\n \"voice\": true,\n \"SMS\": true,\n \"MMS\": true\n },\n \"number\": \"+14433429313\",\n \"phone_number\": \"+14433429313\",\n \"number_type\": \"local\",\n \"addr_required\": \"none\",\n \"hipaa_friendly\": true,\n \"ratecenter\": \"\",\n \"source\": 1\n },\n {\n \"friendly_name\": \"+1 (443) 241-3633\",\n \"latitude\": \"39.575400\",\n \"longitude\": \"-76.995800\",\n \"lata\": \"238\",\n \"region\": \"MD\",\n \"postal_code\": \"21158\",\n \"iso_country\": \"US\",\n \"capabilities\": {\n \"voice\": true,\n \"SMS\": true,\n \"MMS\": true\n },\n \"number\": \"+14432413633\",\n \"phone_number\": \"+14432413633\",\n \"number_type\": \"local\",\n \"addr_required\": \"none\",\n \"hipaa_friendly\": true,\n \"ratecenter\": \"\",\n \"source\": 1\n },\n {\n \"friendly_name\": \"+1 (443) 241-2637\",\n \"latitude\": \"39.575400\",\n \"longitude\": \"-76.995800\",\n \"lata\": \"238\",\n \"region\": \"MD\",\n \"postal_code\": \"21158\",\n \"iso_country\": \"US\",\n \"capabilities\": {\n \"voice\": true,\n \"SMS\": true,\n \"MMS\": true\n },\n \"number\": \"+14432412637\",\n \"phone_number\": \"+14432412637\",\n \"number_type\": \"local\",\n \"addr_required\": \"none\",\n \"hipaa_friendly\": true,\n \"ratecenter\": \"\",\n \"source\": 1\n },\n {\n \"friendly_name\": \"+1 (443) 323-1673\",\n \"latitude\": \"38.542600\",\n \"longitude\": \"-75.719400\",\n \"lata\": \"242\",\n \"region\": \"MD\",\n \"postal_code\": \"21861\",\n \"iso_country\": \"US\",\n \"capabilities\": {\n \"voice\": true,\n \"SMS\": true,\n \"MMS\": true\n },\n \"number\": \"+14433231673\",\n \"phone_number\": \"+14433231673\",\n \"number_type\": \"local\",\n \"addr_required\": \"none\",\n \"hipaa_friendly\": true,\n \"ratecenter\": \"\",\n \"source\": 1\n },\n {\n \"friendly_name\": \"+1 (443) 323-0698\",\n \"latitude\": \"38.542600\",\n \"longitude\": \"-75.719400\",\n \"lata\": \"242\",\n \"region\": \"MD\",\n \"postal_code\": \"21861\",\n \"iso_country\": \"US\",\n \"capabilities\": {\n \"voice\": true,\n \"SMS\": true,\n \"MMS\": true\n },\n \"number\": \"+14433230698\",\n \"phone_number\": \"+14433230698\",\n \"number_type\": \"local\",\n \"addr_required\": \"none\",\n \"hipaa_friendly\": true,\n \"ratecenter\": \"\",\n \"source\": 1\n },\n {\n \"friendly_name\": \"+1 (443) 342-9468\",\n \"latitude\": \"38.334600\",\n \"longitude\": \"-76.468100\",\n \"lata\": \"238\",\n \"region\": \"MD\",\n \"postal_code\": \"20688\",\n \"iso_country\": \"US\",\n \"capabilities\": {\n \"voice\": true,\n \"SMS\": true,\n \"MMS\": true\n },\n \"number\": \"+14433429468\",\n \"phone_number\": \"+14433429468\",\n \"number_type\": \"local\",\n \"addr_required\": \"none\",\n \"hipaa_friendly\": true,\n \"ratecenter\": \"\",\n \"source\": 1\n },\n {\n \"friendly_name\": \"+1 (443) 238-1098\",\n \"latitude\": \"39.647600\",\n \"longitude\": \"-76.679300\",\n \"lata\": \"238\",\n \"region\": \"MD\",\n \"postal_code\": \"21120\",\n \"iso_country\": \"US\",\n \"capabilities\": {\n \"voice\": true,\n \"SMS\": true,\n \"MMS\": true\n },\n \"number\": \"+14432381098\",\n \"phone_number\": \"+14432381098\",\n \"number_type\": \"local\",\n \"addr_required\": \"none\",\n \"hipaa_friendly\": true,\n \"ratecenter\": \"\",\n \"source\": 1\n },\n {\n \"friendly_name\": \"+1 (443) 323-2159\",\n \"latitude\": \"38.542600\",\n \"longitude\": \"-75.719400\",\n \"lata\": \"242\",\n \"region\": \"MD\",\n \"postal_code\": \"21861\",\n \"iso_country\": \"US\",\n \"capabilities\": {\n \"voice\": true,\n \"SMS\": true,\n \"MMS\": true\n },\n \"number\": \"+14433232159\",\n \"phone_number\": \"+14433232159\",\n \"number_type\": \"local\",\n \"addr_required\": \"none\",\n \"hipaa_friendly\": true,\n \"ratecenter\": \"\",\n \"source\": 1\n },\n {\n \"friendly_name\": \"+1 (443) 342-9521\",\n \"latitude\": \"38.334600\",\n \"longitude\": \"-76.468100\",\n \"lata\": \"238\",\n \"region\": \"MD\",\n \"postal_code\": \"20688\",\n \"iso_country\": \"US\",\n \"capabilities\": {\n \"voice\": true,\n \"SMS\": true,\n \"MMS\": true\n },\n \"number\": \"+14433429521\",\n \"phone_number\": \"+14433429521\",\n \"number_type\": \"local\",\n \"addr_required\": \"none\",\n \"hipaa_friendly\": true,\n \"ratecenter\": \"\",\n \"source\": 1\n },\n {\n \"friendly_name\": \"+1 (443) 323-2510\",\n \"latitude\": \"38.542600\",\n \"longitude\": \"-75.719400\",\n \"lata\": \"242\",\n \"region\": \"MD\",\n \"postal_code\": \"21861\",\n \"iso_country\": \"US\",\n \"capabilities\": {\n \"voice\": true,\n \"SMS\": true,\n \"MMS\": true\n },\n \"number\": \"+14433232510\",\n \"phone_number\": \"+14433232510\",\n \"number_type\": \"local\",\n \"addr_required\": \"none\",\n \"hipaa_friendly\": true,\n \"ratecenter\": \"\",\n \"source\": 1\n },\n {\n \"friendly_name\": \"+1 (443) 342-9564\",\n \"latitude\": \"38.334600\",\n \"longitude\": \"-76.468100\",\n \"lata\": \"238\",\n \"region\": \"MD\",\n \"postal_code\": \"20688\",\n \"iso_country\": \"US\",\n \"capabilities\": {\n \"voice\": true,\n \"SMS\": true,\n \"MMS\": true\n },\n \"number\": \"+14433429564\",\n \"phone_number\": \"+14433429564\",\n \"number_type\": \"local\",\n \"addr_required\": \"none\",\n \"hipaa_friendly\": true,\n \"ratecenter\": \"\",\n \"source\": 1\n },\n {\n \"friendly_name\": \"+1 (443) 342-9440\",\n \"latitude\": \"38.334600\",\n \"longitude\": \"-76.468100\",\n \"lata\": \"238\",\n \"region\": \"MD\",\n \"postal_code\": \"20688\",\n \"iso_country\": \"US\",\n \"capabilities\": {\n \"voice\": true,\n \"SMS\": true,\n \"MMS\": true\n },\n \"number\": \"+14433429440\",\n \"phone_number\": \"+14433429440\",\n \"number_type\": \"local\",\n \"addr_required\": \"none\",\n \"hipaa_friendly\": true,\n \"ratecenter\": \"\",\n \"source\": 1\n },\n {\n \"friendly_name\": \"+1 (443) 342-9275\",\n \"latitude\": \"38.334600\",\n \"longitude\": \"-76.468100\",\n \"lata\": \"238\",\n \"region\": \"MD\",\n \"postal_code\": \"20688\",\n \"iso_country\": \"US\",\n \"capabilities\": {\n \"voice\": true,\n \"SMS\": true,\n \"MMS\": true\n },\n \"number\": \"+14433429275\",\n \"phone_number\": \"+14433429275\",\n \"number_type\": \"local\",\n \"addr_required\": \"none\",\n \"hipaa_friendly\": true,\n \"ratecenter\": \"\",\n \"source\": 1\n },\n {\n \"friendly_name\": \"+1 (443) 331-4907\",\n \"latitude\": \"39.657500\",\n \"longitude\": \"-77.174800\",\n \"lata\": \"238\",\n \"region\": \"MD\",\n \"postal_code\": \"21787\",\n \"iso_country\": \"US\",\n \"capabilities\": {\n \"voice\": true,\n \"SMS\": true,\n \"MMS\": true\n },\n \"number\": \"+14433314907\",\n \"phone_number\": \"+14433314907\",\n \"number_type\": \"local\",\n \"addr_required\": \"none\",\n \"hipaa_friendly\": true,\n \"ratecenter\": \"\",\n \"source\": 1\n },\n {\n \"friendly_name\": \"+1 (443) 331-5791\",\n \"latitude\": \"39.657500\",\n \"longitude\": \"-77.174800\",\n \"lata\": \"238\",\n \"region\": \"MD\",\n \"postal_code\": \"21787\",\n \"iso_country\": \"US\",\n \"capabilities\": {\n \"voice\": true,\n \"SMS\": true,\n \"MMS\": true\n },\n \"number\": \"+14433315791\",\n \"phone_number\": \"+14433315791\",\n \"number_type\": \"local\",\n \"addr_required\": \"none\",\n \"hipaa_friendly\": true,\n \"ratecenter\": \"\",\n \"source\": 1\n },\n {\n \"friendly_name\": \"+1 (443) 342-9418\",\n \"latitude\": \"38.334600\",\n \"longitude\": \"-76.468100\",\n \"lata\": \"238\",\n \"region\": \"MD\",\n \"postal_code\": \"20688\",\n \"iso_country\": \"US\",\n \"capabilities\": {\n \"voice\": true,\n \"SMS\": true,\n \"MMS\": true\n },\n \"number\": \"+14433429418\",\n \"phone_number\": \"+14433429418\",\n \"number_type\": \"local\",\n \"addr_required\": \"none\",\n \"hipaa_friendly\": true,\n \"ratecenter\": \"\",\n \"source\": 1\n },\n {\n \"friendly_name\": \"+1 (443) 331-5378\",\n \"latitude\": \"39.657500\",\n \"longitude\": \"-77.174800\",\n \"lata\": \"238\",\n \"region\": \"MD\",\n \"postal_code\": \"21787\",\n \"iso_country\": \"US\",\n \"capabilities\": {\n \"voice\": true,\n \"SMS\": true,\n \"MMS\": true\n },\n \"number\": \"+14433315378\",\n \"phone_number\": \"+14433315378\",\n \"number_type\": \"local\",\n \"addr_required\": \"none\",\n \"hipaa_friendly\": true,\n \"ratecenter\": \"\",\n \"source\": 1\n },\n {\n \"friendly_name\": \"+1 (443) 329-9834\",\n \"latitude\": \"39.099300\",\n \"longitude\": \"-76.848300\",\n \"lata\": \"236\",\n \"region\": \"MD\",\n \"postal_code\": \"20707\",\n \"iso_country\": \"US\",\n \"capabilities\": {\n \"voice\": true,\n \"SMS\": true,\n \"MMS\": true\n },\n \"number\": \"+14433299834\",\n \"phone_number\": \"+14433299834\",\n \"number_type\": \"local\",\n \"addr_required\": \"none\",\n \"hipaa_friendly\": true,\n \"ratecenter\": \"\",\n \"source\": 1\n },\n {\n \"friendly_name\": \"+1 (443) 342-9533\",\n \"latitude\": \"38.320000\",\n \"longitude\": \"-76.450000\",\n \"lata\": \"238\",\n \"region\": \"MD\",\n \"postal_code\": \"20688\",\n \"iso_country\": \"US\",\n \"capabilities\": {\n \"voice\": true,\n \"SMS\": true,\n \"MMS\": true\n },\n \"number\": \"+14433429533\",\n \"phone_number\": \"+14433429533\",\n \"number_type\": \"local\",\n \"addr_required\": \"none\",\n \"hipaa_friendly\": true,\n \"ratecenter\": \"\",\n \"source\": 1\n },\n {\n \"friendly_name\": \"+1 (443) 323-2314\",\n \"latitude\": \"38.542600\",\n \"longitude\": \"-75.719400\",\n \"lata\": \"242\",\n \"region\": \"MD\",\n \"postal_code\": \"21861\",\n \"iso_country\": \"US\",\n \"capabilities\": {\n \"voice\": true,\n \"SMS\": true,\n \"MMS\": true\n },\n \"number\": \"+14433232314\",\n \"phone_number\": \"+14433232314\",\n \"number_type\": \"local\",\n \"addr_required\": \"none\",\n \"hipaa_friendly\": true,\n \"ratecenter\": \"\",\n \"source\": 1\n },\n {\n \"friendly_name\": \"+1 (443) 844-3429\",\n \"latitude\": null,\n \"longitude\": null,\n \"lata\": \"238\",\n \"region\": \"\",\n \"postal_code\": \"\",\n \"iso_country\": \"US\",\n \"capabilities\": {\n \"voice\": true,\n \"SMS\": true,\n \"MMS\": false\n },\n \"number\": \"+14438443429\",\n \"phone_number\": \"+14438443429\",\n \"number_type\": \"local\",\n \"addr_required\": \"\",\n \"hipaa_friendly\": false,\n \"ratecenter\": \"\",\n \"source\": 3\n },\n {\n \"friendly_name\": \"+1 (443) 516-8580\",\n \"latitude\": null,\n \"longitude\": null,\n \"lata\": \"238\",\n \"region\": \"\",\n \"postal_code\": \"\",\n \"iso_country\": \"US\",\n \"capabilities\": {\n \"voice\": true,\n \"SMS\": true,\n \"MMS\": false\n },\n \"number\": \"+14435168580\",\n \"phone_number\": \"+14435168580\",\n \"number_type\": \"local\",\n \"addr_required\": \"\",\n \"hipaa_friendly\": false,\n \"ratecenter\": \"\",\n \"source\": 3\n },\n {\n \"friendly_name\": \"+1 (443) 767-1419\",\n \"latitude\": null,\n \"longitude\": null,\n \"lata\": \"238\",\n \"region\": \"\",\n \"postal_code\": \"\",\n \"iso_country\": \"US\",\n \"capabilities\": {\n \"voice\": true,\n \"SMS\": true,\n \"MMS\": false\n },\n \"number\": \"+14437671419\",\n \"phone_number\": \"+14437671419\",\n \"number_type\": \"local\",\n \"addr_required\": \"\",\n \"hipaa_friendly\": false,\n \"ratecenter\": \"\",\n \"source\": 3\n },\n {\n \"friendly_name\": \"+1 (443) 639-8517\",\n \"latitude\": null,\n \"longitude\": null,\n \"lata\": \"238\",\n \"region\": \"\",\n \"postal_code\": \"\",\n \"iso_country\": \"US\",\n \"capabilities\": {\n \"voice\": true,\n \"SMS\": true,\n \"MMS\": false\n },\n \"number\": \"+14436398517\",\n \"phone_number\": \"+14436398517\",\n \"number_type\": \"local\",\n \"addr_required\": \"\",\n \"hipaa_friendly\": false,\n \"ratecenter\": \"\",\n \"source\": 3\n },\n {\n \"friendly_name\": \"+1 (443) 746-7192\",\n \"latitude\": null,\n \"longitude\": null,\n \"lata\": \"242\",\n \"region\": \"\",\n \"postal_code\": \"\",\n \"iso_country\": \"US\",\n \"capabilities\": {\n \"voice\": true,\n \"SMS\": true,\n \"MMS\": false\n },\n \"number\": \"+14437467192\",\n \"phone_number\": \"+14437467192\",\n \"number_type\": \"local\",\n \"addr_required\": \"\",\n \"hipaa_friendly\": false,\n \"ratecenter\": \"\",\n \"source\": 3\n },\n {\n \"friendly_name\": \"+1 (443) 933-8385\",\n \"latitude\": null,\n \"longitude\": null,\n \"lata\": \"238\",\n \"region\": \"\",\n \"postal_code\": \"\",\n \"iso_country\": \"US\",\n \"capabilities\": {\n \"voice\": true,\n \"SMS\": true,\n \"MMS\": false\n },\n \"number\": \"+14439338385\",\n \"phone_number\": \"+14439338385\",\n \"number_type\": \"local\",\n \"addr_required\": \"\",\n \"hipaa_friendly\": false,\n \"ratecenter\": \"\",\n \"source\": 3\n },\n {\n \"friendly_name\": \"+1 (443) 572-3307\",\n \"latitude\": null,\n \"longitude\": null,\n \"lata\": \"238\",\n \"region\": \"\",\n \"postal_code\": \"\",\n \"iso_country\": \"US\",\n \"capabilities\": {\n \"voice\": true,\n \"SMS\": true,\n \"MMS\": false\n },\n \"number\": \"+14435723307\",\n \"phone_number\": \"+14435723307\",\n \"number_type\": \"local\",\n \"addr_required\": \"\",\n \"hipaa_friendly\": false,\n \"ratecenter\": \"\",\n \"source\": 3\n },\n {\n \"friendly_name\": \"+1 (443) 329-9893\",\n \"latitude\": null,\n \"longitude\": null,\n \"lata\": \"236\",\n \"region\": \"\",\n \"postal_code\": \"\",\n \"iso_country\": \"US\",\n \"capabilities\": {\n \"voice\": true,\n \"SMS\": true,\n \"MMS\": false\n },\n \"number\": \"+14433299893\",\n \"phone_number\": \"+14433299893\",\n \"number_type\": \"local\",\n \"addr_required\": \"\",\n \"hipaa_friendly\": false,\n \"ratecenter\": \"\",\n \"source\": 3\n },\n {\n \"friendly_name\": \"+1 (443) 339-5662\",\n \"latitude\": null,\n \"longitude\": null,\n \"lata\": \"238\",\n \"region\": \"\",\n \"postal_code\": \"\",\n \"iso_country\": \"US\",\n \"capabilities\": {\n \"voice\": true,\n \"SMS\": true,\n \"MMS\": false\n },\n \"number\": \"+14433395662\",\n \"phone_number\": \"+14433395662\",\n \"number_type\": \"local\",\n \"addr_required\": \"\",\n \"hipaa_friendly\": false,\n \"ratecenter\": \"\",\n \"source\": 3\n },\n {\n \"friendly_name\": \"+1 (443) 526-4610\",\n \"latitude\": null,\n \"longitude\": null,\n \"lata\": \"238\",\n \"region\": \"\",\n \"postal_code\": \"\",\n \"iso_country\": \"US\",\n \"capabilities\": {\n \"voice\": true,\n \"SMS\": true,\n \"MMS\": false\n },\n \"number\": \"+14435264610\",\n \"phone_number\": \"+14435264610\",\n \"number_type\": \"local\",\n \"addr_required\": \"\",\n \"hipaa_friendly\": false,\n \"ratecenter\": \"\",\n \"source\": 3\n },\n {\n \"friendly_name\": \"+1 (443) 672-4166\",\n \"latitude\": null,\n \"longitude\": null,\n \"lata\": \"238\",\n \"region\": \"\",\n \"postal_code\": \"\",\n \"iso_country\": \"US\",\n \"capabilities\": {\n \"voice\": true,\n \"SMS\": true,\n \"MMS\": false\n },\n \"number\": \"+14436724166\",\n \"phone_number\": \"+14436724166\",\n \"number_type\": \"local\",\n \"addr_required\": \"\",\n \"hipaa_friendly\": false,\n \"ratecenter\": \"\",\n \"source\": 3\n },\n {\n \"friendly_name\": \"+1 (443) 590-7941\",\n \"latitude\": null,\n \"longitude\": null,\n \"lata\": \"238\",\n \"region\": \"\",\n \"postal_code\": \"\",\n \"iso_country\": \"US\",\n \"capabilities\": {\n \"voice\": true,\n \"SMS\": true,\n \"MMS\": false\n },\n \"number\": \"+14435907941\",\n \"phone_number\": \"+14435907941\",\n \"number_type\": \"local\",\n \"addr_required\": \"\",\n \"hipaa_friendly\": false,\n \"ratecenter\": \"\",\n \"source\": 3\n },\n {\n \"friendly_name\": \"+1 (443) 342-2610\",\n \"latitude\": null,\n \"longitude\": null,\n \"lata\": \"238\",\n \"region\": \"\",\n \"postal_code\": \"\",\n \"iso_country\": \"US\",\n \"capabilities\": {\n \"voice\": true,\n \"SMS\": true,\n \"MMS\": false\n },\n \"number\": \"+14433422610\",\n \"phone_number\": \"+14433422610\",\n \"number_type\": \"local\",\n \"addr_required\": \"\",\n \"hipaa_friendly\": false,\n \"ratecenter\": \"\",\n \"source\": 3\n },\n {\n \"friendly_name\": \"+1 (443) 733-4842\",\n \"latitude\": null,\n \"longitude\": null,\n \"lata\": \"238\",\n \"region\": \"\",\n \"postal_code\": \"\",\n \"iso_country\": \"US\",\n \"capabilities\": {\n \"voice\": true,\n \"SMS\": true,\n \"MMS\": false\n },\n \"number\": \"+14437334842\",\n \"phone_number\": \"+14437334842\",\n \"number_type\": \"local\",\n \"addr_required\": \"\",\n \"hipaa_friendly\": false,\n \"ratecenter\": \"\",\n \"source\": 3\n },\n {\n \"friendly_name\": \"+1 (443) 938-9389\",\n \"latitude\": null,\n \"longitude\": null,\n \"lata\": \"238\",\n \"region\": \"\",\n \"postal_code\": \"\",\n \"iso_country\": \"US\",\n \"capabilities\": {\n \"voice\": true,\n \"SMS\": true,\n \"MMS\": false\n },\n \"number\": \"+14439389389\",\n \"phone_number\": \"+14439389389\",\n \"number_type\": \"local\",\n \"addr_required\": \"\",\n \"hipaa_friendly\": false,\n \"ratecenter\": \"\",\n \"source\": 3\n },\n {\n \"friendly_name\": \"+1 (443) 957-1950\",\n \"latitude\": null,\n \"longitude\": null,\n \"lata\": \"238\",\n \"region\": \"\",\n \"postal_code\": \"\",\n \"iso_country\": \"US\",\n \"capabilities\": {\n \"voice\": true,\n \"SMS\": true,\n \"MMS\": false\n },\n \"number\": \"+14439571950\",\n \"phone_number\": \"+14439571950\",\n \"number_type\": \"local\",\n \"addr_required\": \"\",\n \"hipaa_friendly\": false,\n \"ratecenter\": \"\",\n \"source\": 3\n },\n {\n \"friendly_name\": \"+1 (443) 844-3810\",\n \"latitude\": null,\n \"longitude\": null,\n \"lata\": \"238\",\n \"region\": \"\",\n \"postal_code\": \"\",\n \"iso_country\": \"US\",\n \"capabilities\": {\n \"voice\": true,\n \"SMS\": true,\n \"MMS\": false\n },\n \"number\": \"+14438443810\",\n \"phone_number\": \"+14438443810\",\n \"number_type\": \"local\",\n \"addr_required\": \"\",\n \"hipaa_friendly\": false,\n \"ratecenter\": \"\",\n \"source\": 3\n },\n {\n \"friendly_name\": \"+1 (443) 552-5748\",\n \"latitude\": null,\n \"longitude\": null,\n \"lata\": \"238\",\n \"region\": \"\",\n \"postal_code\": \"\",\n \"iso_country\": \"US\",\n \"capabilities\": {\n \"voice\": true,\n \"SMS\": true,\n \"MMS\": false\n },\n \"number\": \"+14435525748\",\n \"phone_number\": \"+14435525748\",\n \"number_type\": \"local\",\n \"addr_required\": \"\",\n \"hipaa_friendly\": false,\n \"ratecenter\": \"\",\n \"source\": 3\n },\n {\n \"friendly_name\": \"+1 (443) 938-9802\",\n \"latitude\": null,\n \"longitude\": null,\n \"lata\": \"238\",\n \"region\": \"\",\n \"postal_code\": \"\",\n \"iso_country\": \"US\",\n \"capabilities\": {\n \"voice\": true,\n \"SMS\": true,\n \"MMS\": false\n },\n \"number\": \"+14439389802\",\n \"phone_number\": \"+14439389802\",\n \"number_type\": \"local\",\n \"addr_required\": \"\",\n \"hipaa_friendly\": false,\n \"ratecenter\": \"\",\n \"source\": 3\n },\n {\n \"friendly_name\": \"+1 (443) 645-5148\",\n \"latitude\": null,\n \"longitude\": null,\n \"lata\": \"238\",\n \"region\": \"\",\n \"postal_code\": \"\",\n \"iso_country\": \"US\",\n \"capabilities\": {\n \"voice\": true,\n \"SMS\": true,\n \"MMS\": false\n },\n \"number\": \"+14436455148\",\n \"phone_number\": \"+14436455148\",\n \"number_type\": \"local\",\n \"addr_required\": \"\",\n \"hipaa_friendly\": false,\n \"ratecenter\": \"\",\n \"source\": 3\n }\n ],\n \"country\": \"US\",\n \"searchby\": \"area\",\n \"error\": [],\n \"format_style\": \"v2\",\n \"include_distance\": false,\n \"overlays\": [\n \"410\",\n \"667\"\n ],\n \"contains\": null,\n \"areacode\": \"443\",\n \"status\": \"success\"\n}"}],"_postman_id":"f6759000-dded-4a48-9c95-24158d775cbf"},{"name":"search for international numbers","event":[{"listen":"test","script":{"type":"text/javascript","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","var jsonData = JSON.parse(responseBody);","tests[\"numbers is an array\"] = Array.isArray(jsonData.numbers);","tests[\"country is two chars\"] = jsonData.country.length === 2;","tests[\"status is success\"] = jsonData.status === \"success\";"]}}],"id":"941273b2-0449-4fcb-9935-73c170ae3ac4","request":{"method":"GET","header":[{"key":"Authorization","value":"{{Basic Auth}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{host}}/{{base_path}}/accounts/{{account_id}}/numbers/search.json?country=GB&pattern=430","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
country	yes	the ISO_3166-1_alpha-2 two-letter country code
pattern	no	an optional pattern to search for
operator	no	either `start_with` or `includes`

The default operator is includes. It will look for numbers that contain the pattern.

The start_with operator allows you to find numbers by area code and prefix.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
phone_number	yes	use `phone_number` from search
test	no	if you set a value for `test`, you will not actually purchase the number, but it can be used to test setting up tracking number, etc.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
area_code	yes	an area code you want to buy a number in
test	no	if you set a value for `test`, you will not actually purchase the number, but it can be used to test setting up tracking number, etc.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
number	no	optionally filter by the given phone number digits
name	no	optionally filter by the given description of the number.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
receiving_number_id	yes	the RPN id

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
number	yes	a receiving number in [E.164](https://en.wikipedia.org/wiki/E.164 Wikipedia) format (i.e. +18885551212 or +441632960162)
name	no	a label for the receiving number

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
receiving_number_id	yes	the RPN id (receiving number id) to delete

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
receiving_number_id	yes	the receiving number id from details or list
number	yes	a receiving number in [E.164](https://en.wikipedia.org/wiki/E.164 Wikipedia) format (i.e. +18885551212 or +441632960162)
name	no	a label for the receiving number
dial_extension	no	optionally after connecting dial an extension.
dial_extension_wait_time	no	number of seconds to pause before dialing the given extension e.g. 0.0 up to 30.0
fallback_to	no	configure a fallback for this number when not answered or if it rings busy - possibly routing options include: receiving_number, voice_menu, call_queue, conditional_router
fallback_timeout	no	seconds to wait before automatically falling back to a given route. A busy signal or no answer will automatically trigger the fallback
fallback_number_id	no	a receiving number ID
fallback_voice_menu_id	no	a voice menu ID
fallback_call_queue_id	no	a call queue ID
fallback_conditional_router_id	no a smart router e.g. conditional router ID

Route a tracking number to receiving number(s) when you know the receiving number ID(s) (RPN)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
tracking_number_id	yes	the TPN id of the tracking number
dial_route	yes	`number`
numbers_id	yes	an array of RPN IDs (receiving number IDs)
tracking_source_id	no	the tracking source id
number_config_id	no	the number/call setting id

Sample JSON body

{\n    \"dial_route\": \"number\",\n    \"numbers_id\": [ \"RPN...\", \"RPN...\" ]\n}\n

Route a tracking number to receiving numbers that do not already exist

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
tracking_number_id	yes	the TPN id of the tracking number
dial_route	yes	`number`
numbers	yes	an array of phone numbers without the country dial prefix (i.e. no +1 or +44)
country_codes	yes	an array of ISO 3166-1 alpha-2 country codes (i.e. US, CA, GB)
tracking_source_id	no	the tracking source id
number_config_id	no	the number/call setting id
geo_config_id	no	the id of your geo router as well you want to set the dial_route 'geo_config'

Sample JSON body

{\n    \"dial_route\": \"number\",\n    \"numbers\": [\"8665552222\",\"4165553333\"],\n    \"country_codes\": [\"US\",\"CA\"]\n}\n

Sample JSON to set a Geo Router

{\n    \"dial_route\": \"geo_config\",\n    \"geo_config_id\": \"GEO188.....\",\n}\n

Set up other routes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
dial_route	yes	one of `number`, `voice_menu`, `geo_config`, `call_queue`, `conditional_router`, or `call_agent`
tracking_source_id		the tracking source id
number_config_id		the number/call setting id

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
number	no	a phone number to filter the list by
name	no	a phone number name to filter the list by
tracking_number_id	no	a tracking number id to filter the list by

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
target_number_id	yes	the TNI target number ID

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
number	yes	a target number in [E.164](https://en.wikipedia.org/wiki/E.164 Wikipedia) format (i.e. +18885551212 or +441632960162)
name	no	a label for the target number

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
target_number_id	yes	the TNI id (tracking number id) to delete

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
tracking_number_id	yes	the TPN tracking number ID
target_number_id	yes	the TNI target number ID

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
tracking_number_id	yes	the TPN tracking number ID
target_number_id	yes	the TNI target number ID

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
number	no	a phone number to filter the list by
name	no	a phone number name to filter the list by

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
tracking_number_id	yes	the TPN tracking number ID

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
tracking_number_id	yes	the TPN tracking number ID

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
tracking_number_id	yes	the TPN tracking number ID
name	no	the name or label of the tracking number

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
tracking_number_id	yes	the TPN tracking number ID
status	yes	one of `active`, `paused`, or `stopped`

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
receiving_number_id	yes	the RPN receiving number ID
tracking_number_id	yes	the TPN tracking number ID

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
tracking_number_id	yes	the TPN tracking number ID
long_outgoing	no	a value of 1 will enable long (concatenated) text messages. a value of 0 will disable long text messages

This endpoint can only be used to enable SMS on a number that is SMS capable. Possible return values are 200 success, 404 notfound, 200 alreadyenabled, and 406 failure.

\n","urlObject":{"protocol":"https","path":["{{base_path}}","accounts","{{account_id}}","numbers","{{tracking_number_id}}","enable_sms"],"host":["{{host}}"],"query":[{"key":"long_outgoing","value":"1"}],"variable":[]}},"response":[],"_postman_id":"84672bff-6f9b-44ab-9971-1d781416babf"},{"name":"disable SMS","id":"e206e5e0-c2cd-4ab8-a87e-b47103c2fbc7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{access_key}}"},{"key":"password","value":"{{secret_key}}"}],"advancedConfig":[{"key":"showPassword","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"{{Basic Auth}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"name\": \"testing123\"\n}"},"url":"https://{{host}}/{{base_path}}/accounts/{{account_id}}/numbers/{{tracking_number_id}}/disable_sms?long_outgoing=0","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
tracking_number_id	yes	the TPN tracking number ID
long_outgoing	no	a value of 1 will enable long (concatenated) text messages. a value of 0 will disable long text messages

This endpoint can only be used to disable SMS on a number that is SMS capable. Possible return values are 200 success, 404 notfound, 200 alreadydisabled, and 406 failure.

\n","urlObject":{"protocol":"https","path":["{{base_path}}","accounts","{{account_id}}","numbers","{{tracking_number_id}}","disable_sms"],"host":["{{host}}"],"query":[{"key":"long_outgoing","value":"0"}],"variable":[]}},"response":[],"_postman_id":"e206e5e0-c2cd-4ab8-a87e-b47103c2fbc7"},{"name":"remove receiving number from tracking number","id":"0a6ee372-015b-4afd-93a9-9e0ab7e59927","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Authorization","value":"{{Basic Auth}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{host}}/{{base_path}}/accounts/{{account_id}}/numbers/{{tracking_number_id}}/receiving_numbers/{{receiving_number_id}}/rem","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
receiving_number_id	yes	the RPN receiving number ID
tracking_number_id	yes	the TPN tracking number ID

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

parameters	required	comments
account_id	yes	the account id
tracking_number_id	yes	the TPN tracking number ID
dial_route	yes	`voice_menu`
voice_menu_id	yes	the VOM id of the voice menu

Request Body to route to voice mail

{\n  \"virtual_phone_number\": {\n    \"dial_route\": \"voice_menu\",\n    \"voice_menu_id\": \"VOM...\"\n  }\n}\n

Request Body to route to agent

{\n  \"virtual_phone_number\": {\n    \"dial_route\": \"call_agent\",\n    \"user_id\": \"USR043E46722529BCB5FE87E1200DC64BF9\",\n    \"user_default_action_label\": \"voicemail\",\n    \"user_no_answer_seconds\": 25\n  }\n}\n

\n","urlObject":{"protocol":"https","path":["{{base_path}}","accounts","{{account_id}}","numbers","{{tracking_number_id}}","dial_routes"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"d6691013-9f25-4d2c-ad3b-56c4ada9b1ea"},{"name":"release (delete) a tracking number","id":"7a1e3606-344d-44fd-807d-b8dadb219df1","request":{"method":"DELETE","header":[{"key":"Authorization","value":"{{Basic Auth}}"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"formdata","formdata":[]},"url":"https://{{host}}/{{base_path}}/accounts/{{account_id}}/numbers/{{tracking_number_id}}","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{access_key}}"},{"key":"password","value":"{{secret_key}}"}]},"isInherited":true,"source":{"_postman_id":"ae3e0dcf-973f-42aa-a1ed-7aa80a35ff97","id":"ae3e0dcf-973f-42aa-a1ed-7aa80a35ff97","name":"CTM API","type":"collection"}},"urlObject":{"protocol":"https","path":["{{base_path}}","accounts","{{account_id}}","numbers","{{tracking_number_id}}"],"host":["{{host}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"7a1e3606-344d-44fd-807d-b8dadb219df1"}],"id":"74c499a2-647a-4093-9d8b-9b6904eab43e","_postman_id":"74c499a2-647a-4093-9d8b-9b6904eab43e","description":"","auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{access_key}}"},{"key":"password","value":"{{secret_key}}"}]},"isInherited":true,"source":{"_postman_id":"ae3e0dcf-973f-42aa-a1ed-7aa80a35ff97","id":"ae3e0dcf-973f-42aa-a1ed-7aa80a35ff97","name":"CTM API","type":"collection"}}},{"name":"Lookup Query API","item":[{"name":"lookup api","event":[{"listen":"test","script":{"id":"76988f4f-3101-4610-b1a1-bbbecb3f87e7","exec":["tests[\"Status code is 200\"] = responseCode.code === 200;","","var jsonData = JSON.parse(responseBody);","tests[\"tracking code reasonable\"] = jsonData.tracking.match(/^

Authentication

API Usage / Rate Limits

API Reference

Update a sub-account within an agency.

example bodies

example bodies

example body

You can use the batch geo processing interface to easily setup a large geo router using a simple command based interface to

example commands.txt

Mark and Purge

Introduction

Tracking Ready Event

Event Tracking

FormReactor Events

Replacing Images

Introduction

Tracking Code

Callback API

Custom Variables

Conversion Tracking

Setting it up:

PHP

Ruby

Preventing Number Swapping

Route a tracking number to receiving number(s) when you know the receiving number ID(s) (RPN)

Route a tracking number to receiving numbers that do not already exist

Set up other routes

Route Tracking Number to a Voice Menu

Request Body to route to voice mail

Request Body to route to agent