API - Description - SMS Phone Confirmation - GET

Support DQE
Support DQE
  • Updated

There are two calls for SMS Phone confirmation.

SMS Phone Confirmation - GDPR_MSG

Header:
https://{SERVER_ADDRESS}/GDPR_MSG/?Phone={PHONE}&Duration={DURATION}&Custom_sms={Custom_SMS_Content}&Phonecom={VALUE_Phonecom}&Email={VALUE_Email}&Post={VALUE_Post}&Sms={VALUE_Sms}&Country={COUNTRY_CODE}&Licence={LICENCE_CODE}&Company={CompanyName}

 

Simply replace the items in braces with your information:

Parameter Expected value type Value description Mandatory/Optional
Server address {SERVER_ADDRESS} Address of the DQE server that will process the data Mandatory
Licence {LICENCE_CODE} Number assigned to you as your license code Mandatory
Phone {PHONE}

Phone number, format :

YYXXXXXXXXX

Mandatory
Duration {DURATION} Duration validity of the SMS Optional
CustomSMS {Custom_SMS_Content} The SMS content is limited to 125 characters, including spaces, and should avoid special characters. The SMS code will be appended to the end of the message. Mandatory
Phonecom {VALUE_Phonecom} 1 or 0, indicates whether communication via phone calls has been chosen (for the primary phone). Optional
Email {VALUE_Email} 1 or 0, indicates whether communication via email has been chosen (for the primary email). Optional
Post {VALUE_Post} 1 or 0, indicates whether communication via postal mail has been chosen. Optional
Sms {VALUE_Sms} 1 or 0, indicates whether communication via SMS has been chosen (for the primary phone). Optional
Country {COUNTRY_CODE} Country of the phone number Mandatory
Company {CompanyName} Company name (min. 3 caracters and max 11 caracters). Will be used as the SMS sender. Mandatory

 

Optional Parameters
For cases where the end customer has multiple (up to 5) phone numbers, email addresses, or postal addresses, and wishes to specify their consent in detail:

  • SMS2 / SMS3 / SMS4 / SMS5: 1 or 0 – Indicates if communication via SMS has been chosen for the 2nd / 3rd / 4th / 5th phone number.

  • PHONE2 / PHONE3 / PHONE4 / PHONE5: 1 or 0 – Indicates if communication via phone calls has been chosen for the 2nd / 3rd / 4th / 5th phone number.

  • EMAIL2 / EMAIL3 / EMAIL4 / EMAIL5: 1 or 0 – Indicates if communication via email has been chosen for the 2nd / 3rd / 4th / 5th email address.

  • POST2 / POST3 / POST4 / POST5: 1 or 0 – Indicates if communication via postal mail has been chosen for the 2nd / 3rd / 4th / 5th postal address.

SMS Phone Confirmation - GDPR_VERIF

Header:
https://{SERVER_ADDRESS}/GDPR_VERIF/?Phone={PHONE}&Token={SMS_TOKEN}&Pin={CODE_PIN}

 

Simply replace the items in braces with your information:

Parameter Expected value type Value description Mandatory/Optional
Server address {SERVER_ADDRESS} Address of the DQE server that will process the data Mandatory
Phone {PHONE} Phone number in international format. Mandatory
Token {SMS_TOKEN}

ID of the SMS provided in the response to the GDPR_MSG request.

Mandatory
Pin {CODE_PIN} 6-digit PIN code. Mandatory

 

 

Related to

Was this article helpful?

0 out of 0 found this helpful