Carrier Lookup API
This method is used to obtain information about a given phone number. The data returned includes whether the phone is a landline or a mobile device, and which carrier services it.
Invoking the Method Using REST
URL Syntax and Example
The basic URL syntax is as follows:
http(s)://[host:port]/interact/version/[version]/account/[accountID]/resources/deviceInfo/carrierLookup/callerId/{callerId}/
https://gointeract.io/interact/version/2/account/demoAccount/resources/deviceInfo/carrierLookup/callerId/16783455677
Specific URI Fields
URI Field | Data Type | Description |
|---|---|---|
callerId | string | The phone number for which data is required. |
HTTP Method
GET
HTTP Headers
Tenant-Id: <account> Application-Key: <Public API Service application key> Environment-Name: <environment-name>
Expected Responses
Response Scenario | Status Code/Header | Example Message |
|---|---|---|
Success | 200 | <carrier details> |
Invalid security headers | 401 "Unauthenticated-Reason" Header | { "code":"0x7000000", "message": "Request is unauthorized, missing or wrong credentials", "moreInfoUrl":"http://support.uniphore.com", } |
No information about the given number | 404 | No carrier was found for this phone number <phone number> |
Telephony provider settings are expired | 500 | Your Telephony provider is not defined, please contact Uniphore Support and read the following +link+ |
Telephony provider settings are not configured | 500 | Your Telephony provider is not defined, please contact Uniphore Support and read the following +link+ |
General error (internal error from the X‑Platform Server) | 500 | exception |
Invoking the Method Using SOAP
WSDL URL
https://gointeract.io/interact/version/2/agent/soap/agent.wsdl
Headers
Tenant-Id: <account> Application-Key: <Public API Service application key> Environment-Name: <environment-name>
Input Parameters
Parameter | Type | Description |
|---|---|---|
callerId | string | The phone number for which data is required. |
Sample Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/ " xmlns:soap="http://com/jacada/interact/agent/soap"> <soapenv:Header/> <soapenv:Body> <soap:GetCarrierLookupRequest> <soap:callerId>16783455677</soap:callerId> </soap:GetCarrierLookupRequest> </soapenv:Body> </soapenv:Envelope>
Expected Responses
Response Scenario | Example Message |
|---|---|
Success | carrier details (in XML format) |
Invalid security headers | <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <SOAP-ENV:Fault> <faultcode>0x7000000</faultcode> <faultstring>Request is unauthorized, missing or wrong credentials</faultstring> </SOAP-ENV:Fault> </SOAP-ENV:Body> </SOAP-ENV:Envelope> |
No information about the given number | <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <ns2:GetInteractionUniqueIdResponse xmlns:ns2="http://com/jacada/interact/agent/soap"> <ns2:uniqueId>no carrier was found for this phone number <phone number></ns2:uniqueId> </ns2:GetInteractionUniqueIdResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope> |
Telephony provider settings are expired | <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <ns2:GetInteractionUniqueIdResponse xmlns:ns2="http://com/jacada/interact/agent/soap"> <ns2:uniqueId>Your Telephony provider is not defined, please contact Uniphore Support and read the following +link+</ns2:uniqueId> </ns2:GetInteractionUniqueIdResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope> |
Telephony provider settings are not configured | <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <ns2:GetInteractionUniqueIdResponse xmlns:ns2="http://com/jacada/interact/agent/soap"> <ns2:uniqueId>Your Telephony provider is not defined, please contact Uniphore Support and read the following +link+</ns2:uniqueId> </ns2:GetInteractionUniqueIdResponse> </SOAP-ENV:Body> </SOAP-ENV:Envelope> |
General error (internal error from the X‑Platform Server) | exception (in XML format) |