This page describes the responses returned by the SMS Phone Confirmation API.
Related SMS Phone Confirmation documentation:
- SMS Phone Confirmation introduction
- SMS Phone Confirmation GET request
- SMS Phone Confirmation POST request
- SMS Confirmation Swagger documentation
GDPR_MSG request success
The JSON response contains the SMS delivery status and verification metadata.
| Key | Description | Format |
|---|---|---|
| status | SMS delivery status. | STRING |
| timeout | Validity duration of the code in minutes. | STRING |
| companyName | Company name used as the sender. | STRING |
| country | ISO 3-letter country code. | STRING |
| to | Recipient phone number in international format. | STRING |
| channels | Selected communication channels. | JSON OBJECT |
| errors | Error details. | JSON OBJECT |
| smsToken | Unique identifier of the SMS. | STRING |
| dateTime | Date and time the SMS was sent. | STRING |
Status values
| Status | Description |
|---|---|
PENDING |
The SMS was sent to the operator. |
UNDELIVERABLE |
The SMS could not be delivered. |
DELIVERED |
The SMS was successfully delivered. |
EXPIRED |
The SMS expired before delivery confirmation. |
REJECTED |
The SMS was rejected by the operator. |
Main error codes
| Code | Description |
|---|---|
| 00 | No errors. |
| 01 | Missing parameters. |
| 02 | Service not authorized for this licence. |
| 03 | Invalid phone number. |
| 04 | Invalid country code. |
| 05 | Invalid duration. |
| 06 | Country not found. |
| 07 | Invalid company name. |
| 08 | Internal API error. |
| 09 | No delivery status received. |
| 10 | Invalid consent values. |
| 11 | At least one communication channel must be enabled. |
Example:
{
"channels": {
"phone": 0,
"post": 0,
"sms": 1,
"email": 1
},
"to": "33612345678",
"errors": {
"00": "00 - No errors"
},
"status": "DELIVERED",
"smsToken": "C6hfYZIER3CVoGVYwTiZLg",
"timeout": "3",
"companyName": "MYCOMPANY",
"country": "FRA",
"dateTime": "2019-07-29 11:32:32.876709"
}GDPR_VERIF request success
The JSON response contains the verification result for the PIN code.
| Key | Description | Format |
|---|---|---|
| status |
OK if the PIN is valid, KO otherwise. |
STRING |
| phone | Phone number in international format. | STRING |
| dateTime | Verification date and time. | STRING |
| errors | Error details. | JSON OBJECT |
| channels | Selected communication channels. | JSON OBJECT |
Main verification error codes
| Code | Description |
|---|---|
| 00 | No errors. |
| 01 | Missing parameters. |
| 02 | PIN must contain 6 digits. |
| 03 | PIN expired. |
| 04 | PIN invalid for this token or phone number. |
| 05 | Invalid token. |
Example:
{
"status": "OK",
"phone": "33631525429",
"errors": {
"00": "00 - No errors"
},
"channels": {
"phone": 0,
"post": 0,
"sms": 1,
"email": 1
},
"dateTime": "2019-07-29 11:34:48.998397"
}Related to