REST API for SMS Touchpoint

[Note] Check [Integration API Overview] (/docs/how-to-guides/organization-settings "Organization Settings and Configuration") to get the API token. [Note] Keep the API tokens safe. If any of your tokens are compromised, contact support@ pxp.ai immediately to enable regeneration of the token for your integrations.

Touchpoint Token

Touchpoint token is required for SMS integration which will allow submitting requests using API on a specific touchpoint. You are required to supply the API token and Touchpoint token with every request, otherwise, the call will fail and an appropriate error message will be shown.

Keep the Touchpoint token safe

If any token is compromised, contact support@ pxp.ai immediately to enable regeneration of the token.

Access Touchpoint Token

To access collector token, go to specific SMS touchpoint from Touchpoint menu tab (with admin access). To see the token of a touchpoint, click Get API located under Manage.

A modal will open that shows the token, API URL. Note the API key needs to be added to this URL to work.

Requests

All request to Press’nXPress API must be made using secure HTTPS not HTTP.

Enqueue SMS

URL

https://pressnxpress.com/api/v2/channel/sms/{touchpoint token}/enqueue?apiKey={your api key}

Body

Following attributes are expected attributes with the request. These attributes will provide information and context about the contact and feedback requested. Note: the key names are case sensitive.

[Note] Please use [international E.164 formatting] (/docs/how-to-guides/integrations/integration-api-sms#how-does-e164-format-look-like "international E.164 formatting") for the phone numbers in API request to ensure delivery of SMS.

Key	Required
phone	*
email
firstname
lastname
company
identifier

Additional Context

In addition to default attribute keys to identify the respondent, other elements can be passed on as part of feedback response to capture extra context related to feedback e.g. purchase amount, orderId, product SKU, etc. These additional elements should be included as pair of key and value in the body.

[Note] Additional attributes keys are case sensitive. Ensure the same format is used in all the requests. Otherwise the data will be stored and reported as a new attribute.

Key	Required
amount
SKU

content-type

The content-type can be json or urlencoded.

CURL

curl -X POST \
  'https://pressnxpress.com/api/v2/channel/sms/{touchpoint token}/enqueue?apiKey={your api key}' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'phone={targetPhone}' <b>curl</b>.

Responses

The response data is always returned as JSON.

Success Response

All success response follows the same schema.

{
  "message":"string"
}

Error Response

All error response follows the same schema.

{
  "message":"string"
}

How does E.164 format look like?

E.164 is an internationally-recognized standard phone number format that will help to ensure deliverability of SMS messages. E.164 phone number formatting entails the following:

• A + (plus) sign (replacing the International Call Prefix like 011)
• International Country Calling code
• Local Area code
• Local Phone number

For example, a US-based number in standard local formatting look like: (965) 222-4581. The same phone number in E.164 formatting looks like: +19652224581

If you have any question contact support@ pxp.ai