×

SMS API Documentation

 

Envoyer un SMS avec la méthode GET

 

GET URL: https://api.dream-digital.info/api/v2/SendSMS?ApiKey={ApiKey}&ClientId={ClientId}&SenderId={SenderId}&Message={Message}&MobileNumbers={MobileNumbers}&Is_Unicode={Is_Unicode}&Is_Flash={Is_Flash}


Parameters :

Parameter NameDescriptionType
ApiKeyApiKey used for authentication purpose.String
ClientIdClientId used for authentication purpose.String
SenderIdApproved Sender IdString
Messagetext message to sendString
MobileNumbersUse mobile number as comma sepreated to send message on multiple mobile number
e.g. 78461230,78945612
String
Is_Unicode (optional)Is_Unicode is true or false for unicode messageBoolean
Is_Flash (optional)Is_Flash is true or false for flash messageBoolean
ScheduleTime (optional)ScheduleTime Date in yyyy-MM-dd HH:MM (only for schedule message)String
GroupId (optional)Valid group-id of current user (only for group message otherwise leave empty string)String

 

 

HEADERS :
Content-Type : application/json or application/xml
Type : json or xml

 

Réponse de l'API:

Json ResponseXml Response

{  "ErrorCode": 0,  "ErrorDescription": "Success",  "Data": [    {      "MobileNumber": "7894561230",      "MessageId": "3bb944ad-d943-419f-83dc-f979002a8c0b"    }  ] }

<ResponseModelOfListOfManageNumberDetail>  <ErrorCode>0</ErrorCode>  <ErrorDescription>Success</ErrorDescription>  <Data>    <ManageNumberDetail>      <MobileNumber>7894561230</MobileNumber>      <MessageId>083d9fa5-3fc6-4cac-80fa-7af8227a6c68</MessageId>    </ManageNumberDetail>  </Data> </ResponseModelOfListOfManageNumberDetail>

 

Envoyer un SMS avec la méthode POST

 

POST URL: https://api.dream-digital.info/api/v2/SendSMS


Request Body :

JSONXML

{  "SenderId": "string",  "Is_Unicode": true,  "Is_Flash": true,  "SchedTime": "string",  "GroupId": "string",  "Message": "string",  "MobileNumbers": "string",  "ApiKey": "string",  "ClientId": "string" }

<?xml version="1.0"?> <SendSMSModel>  <SenderId>string</SenderId>  <Is_Unicode>true</Is_Unicode>  <Is_Flash>true</Is_Flash>  <SchedTime>string</SchedTime>  <GroupId>string</GroupId>  <Message>string</Message>  <MobileNumbers>string</MobileNumbers>  <ApiKey>string</ApiKey>  <ClientId>string</ClientId> </SendSMSModel>

 

Parametres :

Parameter NameDescriptionType
ApiKeyApiKey used for authentication purpose.String
ClientIdClientId used for authentication purpose.String
SenderIdApproved Sender IdString
Messagetext message to sendString
MobileNumbersUse mobile number as comma sepreated to send message on multiple mobile number
e.g. 78461230,78945612
String
Is_Unicode (optional)Is_Unicode is true or false for unicode messageBoolean
Is_Flash (optional)Is_Flash is true or false for flash messageBoolean
ScheduleTime (optional)ScheduleTime Date in yyyy-MM-dd HH:MM (only for schedule message)String
GroupId (optional)Valid group-id of current user (only for group message otherwise leave empty string)String
HEADERS :
Content-Type : application/json or application/xml
Type : json or xml

 

Réponse de l'API en POST:

 

Json ResponseXml Response

{  "ErrorCode": 0,  "ErrorDescription": "Success",  "Data": [    {      "MobileNumber": "7894561230",      "MessageId": "5c0780c2-d6f2-40a8-a40a-ee74e28fa4c2"    }  ] }

<ResponseModelOfListOfManageNumberDetail">  <ErrorCode>0</ErrorCode>  <ErrorDescription>Success</ErrorDescription>  <Data>    <ManageNumberDetail>      <MobileNumber>7894561230</MobileNumber>      <MessageId>64847d15-ea24-4c51-8d15-8cfdf9b07bed</MessageId>    </ManageNumberDetail>  </Data> </ResponseModelOfListOfManageNumberDetail>

 

Il existe plusieurs autres possibilités avec cette API que vous pouvez trouver sur le lien ci-dessous.
Le lien n'est accessible que si vous êtes connecté à votre compte client.

API DOC: https://smsuser.dream-digital.info/ApiDocument/ApiDocs

 

N'hésitez pas à nous contacter pour toute autre question.