GDPR MSG request success
The JSON response is a dictionary. The value in this key is an array of all suggested email addresses:
| Key | Description | France | International |
| status | SMS delivery status (e.g., DELIVERED). | STRING | STRING |
| timeout | Validity duration of the code in minutes. | STRING | STRING |
| companyName | Name of the company | STRING | STRING |
| country | ISO 3-letter country code | STRING | STRING |
| to | Phone number to which the SMS was sent (in international format) | STRING | STRING |
| channels | Selected communication channels (see next table) | JSON Object | JSON Object |
| errors | Error code table: "00" - No errors. Detailed error information (see full list below) | JSON Object | JSON Object |
| smsToken | Unique ID of the sent message (must be provided at the verification step) | STRING | STRING |
| dateTime | Date and time the SMS was sent | STRING | STRING |
"Channels" table :
| Key | Description | France | International |
| sms |
1: Indicates the communication channel was chosen. 0: Indicates the communication channel was not chosen. |
INTEGER | INTEGER |
| phone |
1: Indicates the communication channel was chosen. 0: Indicates the communication channel was not chosen. |
INTEGER | INTEGER |
|
1: Indicates the communication channel was chosen. 0: Indicates the communication channel was not chosen. |
INTEGER | INTEGER | |
| post |
1: Indicates the communication channel was chosen. 0: Indicates the communication channel was not chosen. |
INTEGER | INTEGER |
"Status" table:
| Value | Description |
| PENDING | The message has been processed and sent to the next instance (mobile operator). |
| UNDELIVERABLE | The message was sent to the operator but could not be delivered. |
| DELIVERED | The message was successfully delivered. |
| EXPIRED | The message sent to the operator has expired after exceeding the waiting period of 48 hours, or the final status returned by the operator is marked as expired. |
| REJECTED | The message was rejected due to the status returned by the operator. |
"errors" table :
| Value | Description |
| 00 | 00 - No errors |
| 01 | 01 - One or more parameters not provided |
| 02 | 02 - The service is not authorized for this license code |
| 03 | 03 - Phone number is not valid: only digits are required without international prefix (e.g., 06XXXXXXXX) |
| 04 | 04 - The country code is not valid: a 3-letter ISO code is required |
| 05 | 05 - The duration is not valid: only digits are required |
| 06 | 06 - The country is not found, please check the country code |
| 07 | 07 - The company name is not valid: the length should be between 3 and 11 characters (e.g., CompanyName) |
| 08 | 08 - Sorry, an error occurred on the API side, please try again later |
| 09 | 09 - The message has been sent but no delivery status received |
| 10 | 10 - Wrong value: only '0' or '1' are accepted for the following parameters: SMS, Phonecom, Email, Post |
| 11 | 11 - At least one of the following parameters should have the value '1' (True): SMS, Phonecom, Email, Post |
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
| Key | Description | France | International |
| status | Indicates the verification status: "OK" - if the PIN is correct and verified before expiration; "KO" - if the PIN is incorrect or expired. | STRING | STRING |
| phone | Phone number provided as input (in international format). | STRING | STRING |
| dateTime | Date and time of the verification. | STRING | STRING |
| errors | Error code table: "00" - No errors. Detailed error information (see complete list below). | STRING | STRING |
| channels | Selected communication channels (see next table) | JSON Object | JSON Object |
"channels" table :
| Key | Description | France | International |
| sms |
1: Indicates the communication channel was chosen. 0: Indicates the communication channel was not chosen. |
INTEGER | INTEGER |
| phone |
1: Indicates the communication channel was chosen. 0: Indicates the communication channel was not chosen. |
INTEGER | INTEGER |
|
1: Indicates the communication channel was chosen. 0: Indicates the communication channel was not chosen. |
INTEGER | INTEGER | |
| post |
1: Indicates the communication channel was chosen. 0: Indicates the communication channel was not chosen. |
INTEGER | INTEGER |
"errors" table :
| Value | Description |
| 00 | 00 - No errors |
| 01 | 01 - One or more parameters not provided |
| 02 | 02 - The PIN code should contain 6 digits |
| 03 | 03 - The PIN is expired |
| 04 | 04 - The PIN is not valid for this token or/and phone number |
| 05 | 05 - The token is not valid |
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