Notify Carrier Lookup API
This method notifies the X‑Platform reporting component about a SMS carrier lookup when an external provider is used. The data returned includes whether the phone is a landline or a mobile device, and which carrier services it.
Note
This method should be invoked only when using an external SMS provider.
Invoking the Method Using REST
URL Syntax and Example
http(s)://[host:port]/interact/version/[version]/account/[accountID]/resources/campaign/{campaignId}/notifyCarrierLookup/callerId/{callerId}/
https://gointeract.io/interact/version/2/account/12345678/resources/campaign/campaign1/notifyCarrierLookup/callerId/+16783455677
Specific URI Fields
URI Field | Data Type | Description |
|---|---|---|
callerId | string | The phone number for which data is required. |
campaignId | string | Name of the campaign recorded in Funnel Report data collections. |
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> |
General error (internal error from the X‑Platform Server) | 500 | exception |