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 URL of the Carrier Lookup API has two different syntaxes, depending on whether or not you want to collect information for a campaign-type Funnel Report

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

To support collection of data for campaign-type Funnel Reports, use the following syntax:

http(s)://[host:port]/interact/version/[version]/account/[accountID]/resources/campaign/{campaignId}/carrierLookup
/callerId/{callerId}/

https://gointeract.io/interact/version/2/account/demoAccount/resources/campaign/camp1/carrierLookup
/callerId/+972548120901

Specific URI Fields

URI FieldData TypeDescription
callerId string The phone number for which data is required.
campaignId string Name of the campaign to associate with the lookup. This parameter is relevant only if you want to support data collection for campaign-type Funnel Reports.

HTTP Method
GET

HTTP Headers

Tenant-Id: <account>
Application-Key: <Public API Service application key>

Expected Responses

Response ScenarioStatus Code/HeaderExample Message
Success 200 <carrier details>
Invalid security headers 401
"Unauthenticated-Reason" Header
{
"code":"0x7000000",
"message": "Request is unauthorized, missing or wrong credentials",
"moreInfoUrl":"http://www.jacada.com/support",
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 Jacada Support and read the following +link+
Telephony provider settings are not configured 500 Your Telephony provider is not defined, please contact Jacada Support and read the following +link+
General error (internal error from the Interact 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>

Input Parameters

ParameterTypeDescription
callerId string The phone number for which data is required.
campaignId string Name of the campaign to associate with the lookup. This parameter is relevant only if you want to support data collection for campaign-type Funnel Reports.

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 ScenarioExample 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 Jacada 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 Jacada Support and read the following +link+</ns2:uniqueId>
        </ns2:GetInteractionUniqueIdResponse>
     </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
General error (internal error from the Interact server) exception (in XML format)

Revision:

Comments