{"__v":0,"_id":"5451f81a14af501a00b50fde","category":{"__v":6,"_id":"54510356a66f020800dbaa17","pages":["545103947abbbc0800a5eb90","54535e2008d1800800473d37","5451f81a14af501a00b50fde","54535f6f90000908009522cf","5451f9f114af501a00b50fec","5453606308d1800800473d3d"],"project":"542dbe0ecb19820800c1f4d7","version":"542ecc0a6b0eb6080066ca77","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-10-29T15:10:14.801Z","from_sync":false,"order":18,"slug":"carrier-services","title":"Carrier Services"},"editedParams":true,"editedParams2":true,"is_link":false,"parentDoc":null,"project":"542dbe0ecb19820800c1f4d7","user":"544a586d27b7fc140078db12","version":{"__v":29,"_id":"542ecc0a6b0eb6080066ca77","forked_from":"542dbe0fcb19820800c1f4da","project":"542dbe0ecb19820800c1f4d7","createdAt":"2014-10-03T16:17:14.165Z","releaseDate":"2014-10-03T16:17:14.165Z","categories":["542ecc0a6b0eb6080066ca78","542ef44f6b0eb6080066cb24","543bf3e22a30961a00b66eb3","5446952b82bd7e08002768a0","544821ae8d7af31a00dd41ce","544a7885f1aefa08006efc69","544c758e11845f0e001ed8de","544e5565b80812080035be55","544e558dbd51b9080037f8ca","5450b045a66f020800dba73d","5450eb6aa66f020800dba945","5450f39ea66f020800dba989","5450f877a66f020800dba9cf","54510356a66f020800dbaa17","5451274514af501a00b50c99","54513345a66f020800dbab24","54513cc014af501a00b50d24","54515eec14af501a00b50db9","54519b1d14af501a00b50ea9","54519b2aa66f020800dbacb4","54524f9704160008005b1d27","54538d2308d1800800473d95","54538d420c09721000a06a03","54538e5608d1800800473d9a","5453ea9547c30114004fb375","5453eb12b077c31c00067bcb","5453eb27b077c31c00067bcd","5453ed5db077c31c00067bde","548075cbe291c51a00e7e096"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-10-30T08:34:34.978Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"basic_auth":true,"method":"post","results":{"codes":[{"code":"{\n\t\"phone_number\": \"[E.164}\",\n\t\"body\": \"VIRGINIA CALL\",\n\t\"sid\": \"{CnamLookupSid}\",\n\t\"date_updated\": \"Thu, 30 Oct 2014 08:25:46 -0000\",\n\t\"date_created\": \"Thu, 30 Oct 2014 08:25:46 -0000\",\n\t\"price\": \"0.01\",\n\t\"uri\": \"/v2/Accounts/{AccountSid}/CNAM/{CnamLookupSid}\",\n\t\"api_version\": \"v2\",\n\t\"account_sid\": \"{AccountSid}\"\n}","language":"json","status":200},{"code":"{\n    \"status\": 404,\n    \"message\": \"The requested resource was not found: /v2/Accounts/bad/bad_response.json\"\n}","language":"json","status":404}]},"try":true,"auth":"required","params":[{"_id":"5451f81a14af501a00b50fe0","ref":"","in":"path","required":true,"desc":"Account SID.","default":"","type":"string","name":"AccountSid"},{"_id":"5451f81a14af501a00b50fdf","ref":"","in":"body","required":true,"desc":"The number of the phone you are attempting to perform the CNAM lookup on. Multiple PhoneNumbers to lookup can be specified in a single request.","default":"","type":"array_mixed","name":"PhoneNumber"}],"url":"/:version/Accounts/:AccountSid/Lookups/Cnam.json"},"isReference":false,"order":2,"body":"TelAPI provides a way to lookup the CNAM (caller name) caller ID information of a phone number via the REST API.\n\n# **Response Parameters**\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Description\",\n    \"0-1\": \"An alphanumeric string identifying this resource.\",\n    \"0-0\": \"sid\",\n    \"1-0\": \"account_sid\",\n    \"1-1\": \"An alphanumeric string identifying the account this lookup occurred through.\",\n    \"2-0\": \"date_created\",\n    \"2-1\": \"The date the lookup resource was created.\",\n    \"3-0\": \"date_updated\",\n    \"3-1\": \"The date the lookup resource was last updated.\",\n    \"4-0\": \"phone_number\",\n    \"4-1\": \"The phone number the lookup was performed on.\",\n    \"5-0\": \"body\",\n    \"5-1\": \"The result of our CNAM lookup. Usually a name or organisation associated with this phone.\",\n    \"6-0\": \"price\",\n    \"6-1\": \"The cost of the lookup.\",\n    \"7-0\": \"api_version\",\n    \"7-1\": \"The API version being used when the carrier lookup was made.\",\n    \"8-0\": \"uri\",\n    \"8-1\": \"The Uniform Resource Identifier to this resource.\"\n  },\n  \"cols\": 2,\n  \"rows\": 9\n}\n[/block]\n# **Example cURL**\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -X POST -u '{AccountSid}:{AuthToken}' -d 'PhoneNumber={PhoneNumber}' 'https://api.telapi.com/v2/Accounts/{AccountSid}/Lookups/Cnam.json'\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]","excerpt":"shows a CNAM information on some phone number","slug":"cnam-lookup","type":"endpoint","title":"CNAM Lookup"}

postCNAM Lookup

shows a CNAM information on some phone number

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

AccountSid:
required
string
Account SID.

Body Params

PhoneNumber:
required
array of mixed
The number of the phone you are attempting to perform the CNAM lookup on. Multiple PhoneNumbers to lookup can be specified in a single request.

Result Format


Documentation

TelAPI provides a way to lookup the CNAM (caller name) caller ID information of a phone number via the REST API. # **Response Parameters** [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Description", "0-1": "An alphanumeric string identifying this resource.", "0-0": "sid", "1-0": "account_sid", "1-1": "An alphanumeric string identifying the account this lookup occurred through.", "2-0": "date_created", "2-1": "The date the lookup resource was created.", "3-0": "date_updated", "3-1": "The date the lookup resource was last updated.", "4-0": "phone_number", "4-1": "The phone number the lookup was performed on.", "5-0": "body", "5-1": "The result of our CNAM lookup. Usually a name or organisation associated with this phone.", "6-0": "price", "6-1": "The cost of the lookup.", "7-0": "api_version", "7-1": "The API version being used when the carrier lookup was made.", "8-0": "uri", "8-1": "The Uniform Resource Identifier to this resource." }, "cols": 2, "rows": 9 } [/block] # **Example cURL** [block:code] { "codes": [ { "code": "curl -X POST -u '{AccountSid}:{AuthToken}' -d 'PhoneNumber={PhoneNumber}' 'https://api.telapi.com/v2/Accounts/{AccountSid}/Lookups/Cnam.json'", "language": "shell" } ] } [/block]