{"info":{"_postman_id":"0db1f1cf-f7a1-4002-a2bd-a2bc1092422d","name":"DEXCHANGE SMS","description":"

Packages

\n

JAVASCRIPT: https://www.npmjs.com/package/dsms

\n

PYTHON: https://pypi.org/project/dexchange-sms/

\n

FLUTTER: https://pub.dev/packages/flutter_dexchange_sms

\n

BASE URL

\n

https://api-v2.dexchange-sms.com

\n

SMS COST

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
COUNTRYCOST
SENEGAL10 XOF / message (160 caracteres) [1 unit]
OTHERS50 XOF / message (160 caracteres) [1 unit]
\n
","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Packages","slug":"packages"},{"content":"BASE URL","slug":"base-url"}],"owner":"23992877","collectionId":"0db1f1cf-f7a1-4002-a2bd-a2bc1092422d","publishedId":"2s93ebTrC1","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-05-11T14:04:32.000Z"},"item":[{"name":"Message API","item":[{"name":"Send SMS Message","id":"09ed4cd7-11c0-470f-816f-9f0f08b8f5be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"number\": [221773435776, 221777777777],\n \"signature\": \"DSMS\",\n \"content\": \"YO\\nCV ?\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-v2.dexchange-sms.com/api/send/sms/","description":"

Example Request

\n","urlObject":{"protocol":"https","path":["api","send","sms",""],"host":["api-v2","dexchange-sms","com"],"query":[],"variable":[]}},"response":[{"id":"43402901-6928-4ea2-8daa-2686d4b03e7b","name":"Send SMS Message","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"number\": [\n \"221777460452\",\n \"777460452\"\n \n ],\n \"signature\": \"DSMS\",\n \"content\": \"YO\\nCV ?\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dexchange-sms.com/api/send/sms"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Fri, 19 May 2023 02:10:27 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"155"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"9b-KkkJZjRTm/XOYsQRpLJdxGZuXJs\""}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Message sent successfully\",\n \"smsID\": \"SID-86c8b597-6a25-3666-a85f-aa2738b8f9cd\",\n \"total_sms\": 1,\n \"total_caracteres\": 7,\n \"invalidNumber\": [\n \"777460452\"\n ]\n}"}],"_postman_id":"09ed4cd7-11c0-470f-816f-9f0f08b8f5be"},{"name":"SEND OTP","id":"6e36c4e8-16a6-4909-be00-49d61bd0da29","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"number\": \"221777460452\",\n \"service\": \"DEMO\",\n \"lang\": \"fr\",\n \"canal\": \"whatsapp_OR_sms\"\n\n}","options":{"raw":{"language":"json"}}},"url":"https://api-v2.dexchange-sms.com/api/send/otp","description":"
This endpoint allows authenticated users to send a one-time password (OTP) via SMS to a phone number. The OTP is generated randomly and appended to a message in a specific language, according to the service parameter provided.
\n

URL: https://api.dexchange-sms.com/api/send/otp
Method: POST

\n

Required request body parameters:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropertyTypeRequiredDescription
numberstringyesThe phone number where the SMS should be sent. Must be a string, even if it contains only digits
servicestringyesThe name of the service for which the OTP is being generated. This parameter determines the language of the OTP message
langstringnoThe language in which to generate the OTP message. If not provided, the default language for the service will be used.
canalstringno (default SMS)sms or whatsapp
\n

Request Headers

\n

The request must include an Authorization header with a valid API key.

\n

Response

\n

The server responds with a JSON object containing the following properties:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropertyTypeDescription
messagestringA message describing the result of the SMS sending
smsIDstringAn ID assigned to the sent SMS message
total_smsnumberThe total number of SMS units used to send the message
\n

Possible HTTP status codes:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Status CodeDescription
201SMS message sent and saved successfully in database
400Bad request: missing or invalid input data
401Unauthorized: missing or invalid API key
500Internal server error
\n
","urlObject":{"protocol":"https","path":["api","send","otp"],"host":["api-v2","dexchange-sms","com"],"query":[],"variable":[]}},"response":[{"id":"c68f3335-8153-479a-a144-b7f2f6161af4","name":"SEND OTP","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"number\": \"221777460452\",\n \"service\": \"DEMO\",\n \"lang\": \"en\"\n\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dexchange-sms.com/api/send/otp"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Fri, 19 May 2023 02:11:17 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"104"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"68-J1Z96P4Te30bh+ViuZW4wkJFYsk\""}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Message sent successfully\",\n \"smsID\": \"AID-2b41dd52-8663-31c7-9287-74494f9f06e8\",\n \"total_sms\": 1\n}"}],"_postman_id":"6e36c4e8-16a6-4909-be00-49d61bd0da29"},{"name":"Verify OTP","id":"3afbc086-e37d-42ea-84c1-562a9a30ab7f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"number\": \"221777460452\",\n \"service\": \"DEMO\",\n \"otp\": \"214045\"\n\n}","options":{"raw":{"language":"json"}}},"url":"https://api-v2.dexchange-sms.com/api/verify/otp","description":"

Verify OTP SMS

\n

Verify OTP SMS is an endpoint that verifies an OTP sent to a user's phone number.

\n

Request

\n
    \n
  • Route: POST /api/verify/otp
    • \n
  • Headers:
      \n
    • Authorization: Bearer API_KEY
        \n
      • API_KEY is the API key generated by the user.
        • \n
      \n
      • \n
    \n
    • \n
  • Body:
    • \n
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
FieldTypeRequiredDescription
numberstringyesThe user's phone number.
otpstringyesThe OTP to be verified.
servicestringyesThe name of the service.
\n

Response

\n
    \n
  • Success:
      \n
    • Status code: 200 OK
      • \n
    • Body: { message: \"OTP verified successfully\" }
      • \n
    \n
    • \n
  • Error:
      \n
    • Status code: 400 Bad Request
      • \n
    • Body: { message: \"OTP invalide\" }
      • \n
    • Status code: 400 Bad Request
      • \n
    • Body: { message: \"OTP already verified\" }
      • \n
    • Status code: 401 Unauthorized
      • \n
    • Body: { message: \"API Key not found\" }
      • \n
    \n
    • \n
\n","urlObject":{"protocol":"https","path":["api","verify","otp"],"host":["api-v2","dexchange-sms","com"],"query":[],"variable":[]}},"response":[{"id":"ab9c0626-2dca-4f91-8933-1f6d419df661","name":"Verify OTP","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"number\": \"221777460452\",\n \"service\": \"DEMO\",\n \"otp\": \"399358\"\n\n}","options":{"raw":{"language":"json"}}},"url":"{{HOST}}/api/verify/otp"},"status":"Success","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"34"},{"key":"ETag","value":"W/\"22-GUHfk2csf1Z6qQgeyeL+SMqnDXc\""},{"key":"Date","value":"Thu, 11 May 2023 23:01:47 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"OTP verified successfully\"\n}"}],"_postman_id":"3afbc086-e37d-42ea-84c1-562a9a30ab7f"}],"id":"d7fd83b7-5bb6-4cab-805c-4567e9e2765a","description":"

API Endpoint: Send SMS

\n

This endpoint allows authorized users to send SMS to multiple recipients.

\n

HTTP Request

\n

POST /api/send/sms

\n

Request Body

\n

The request body must be a JSON object with the following properties:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropertyTypeRequiredDescription
numberarrayyesAn array of phone numbers (strings) of the SMS recipients
contentstringyesThe content of the SMS message
signaturestringyesThe signature to appear on the SMS message
\n

Request Headers

\n

The request must include an Authorization header with a valid API key.

\n

Response

\n

The server responds with a JSON object containing the following properties:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropertyTypeDescription
messagestringA message describing the result of the SMS sending
smsIDstringAn ID assigned to the sent SMS message
total_smsnumberThe total number of SMS units used to send the message
total_caracteresnumberThe total number of characters in the SMS message
\n

Possible HTTP status codes:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Status CodeDescription
201SMS message sent and saved successfully in database
400Bad request: missing or invalid input data
401Unauthorized: missing or invalid API key
500Internal server error
\n

Note: If your signature is in pending verification or has not been yet verified the API will use the default SMS signature: DSMS

\n","auth":{"type":"bearer","bearer":{"basicConfig":[]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"656a11e3-ca76-49e8-9b31-f13029afe568","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"fd454734-9c26-4e1f-9dd7-52c6f346efda","type":"text/javascript","exec":[""]}}],"_postman_id":"d7fd83b7-5bb6-4cab-805c-4567e9e2765a"},{"name":"BALANCE","id":"15771413-2189-4dda-bf83-f13161faea78","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"apikey\": \"YOUR_API_KEY\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api-v2.dexchange-sms.com/api/balance","urlObject":{"protocol":"https","path":["api","balance"],"host":["api-v2","dexchange-sms","com"],"query":[],"variable":[]}},"response":[{"id":"dbd7ea8f-2379-4aab-a8f4-0f3cdda6f37e","name":"GET BALANCE","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"apikey\": \"YOUR_API_KEY\"\n}","options":{"raw":{"language":"json"}}},"url":"https://api.dexchange-sms.com/api/balance"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Wed, 14 Jun 2023 03:48:04 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"79"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"ETag","value":"W/\"4f-MSaTtQGny29cF3Eq/qbuCzfaTjI\""}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Balance found\",\n \"solde_sms\": 9374,\n \"email\": \"email@gmail.com\"\n}"}],"_postman_id":"15771413-2189-4dda-bf83-f13161faea78"}]}