Notify SMS API
This method notifies the X‑Platform reporting component that a SMS message was sent by an external provider. It does not send the message.
Note
This method should be invoked only when using an external SMS provider.
Usage with Deflected Call Report API
This implementation supports functionality required by reporting APIs such as the Deflected Call Report API. This API uses the tokens jpToken and callerID (passed in the HTML body) in order to uniquely identify calls.
When it is called, this API will set the variable smsSent to True for subsequent use in aggregation reporting.
Invoking the Method Using REST
URL Syntax and Example
http(s)://[host:port/internalPath]/Application Name/version/[version]/account/[accountID]/resources/campaign/sms/notify/{CampaignId}/
https://gointeract.io/interact/version/3/account/12345678/resources/campaign/sms/notify/campaign1
Specific URI Fields
URI Field | Data Type | Description |
|---|---|---|
campaignId | string | Identifier for the relevant campaign |
HTTP Method
POST
HTTP Headers
Tenant-Id: <account> Application-Key: <Public API Service application key> Environment-Name: <environment-name>
HTTP Body
{ "callerId" : "+972 54 4696388", "jpToken" : "Aejhib7" }
URI Field | Data Type | Description |
|---|---|---|
callerId | string | Customer phone number |
jpToken | string | Unique token returned from generateToken API |
Sample Request
POST /interact/version/2/account/12345678/resources/campaign/sms/notify/{CampaignId} HTTP/1.1
Host: localhost:8080
Tenant-Id: {tenantId}
Application-Key: 53736e07e4b05772e6475c2d
Content-Type: application/json
Cache-Control: no-cache
{ "callerId" : "+972 54 4696388", "jpToken" : "Aejhib7" }Expected Responses
Response Scenario | Status Code/Header | Example Message |
|---|---|---|
Success | 200 | Placed campaign {<campaign id>} in SMS queue messageSid: SM3ae49ea884e3494e903b13b2681aba3e |
Invalid body parameter(s) | 400 | missing or invalid parameter <parameter> |
Invalid security headers | 401 "Unauthenticated-Reason" Header | { "code":"0x7000000", "message": "Request is unauthorized, missing or wrong credentials", "moreInfoUrl":"http://support.uniphore.com", } |
Outdated campaign/interaction session | 403 | Token expired |
Campaign does not exist | 404 | Campaign <campaign id> was not found |
General error (internal error from the X‑Platform Server) | 500 | exception |