{"info":{"_postman_id":"77181f2e-5ab3-49d7-9b8d-d37be08a3c14","name":"Unifiedway India","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"38784468","collectionId":"77181f2e-5ab3-49d7-9b8d-d37be08a3c14","publishedId":"2sAXxLDEzC","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-10-04T09:04:50.000Z"},"item":[{"name":"Send SMS","item":[{"name":"Text Message","id":"4e87d104-2428-48bc-aaf4-66cd6d660471","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"from_phone_number\":\"{{header_id}}\",\r\n \"to_phone_number\":\"+918401324266\",\r\n \"template_sid\":\"HXe2dadb628dd84e158242bad81fb5bb8a\",\r\n \"data\":{\r\n \"{{1}}\":\"Satya\",\r\n \"{{2}}\":\"Rigel\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://unifiedway-api-in.allinonecentral.com/api/send/template-message","description":"

Send Template Message

This endpoint is used to send a template message via HTTP POST request.

Request Body

from_phone_number (string, required): The phone number of the Header ID.
\n
to_phone_number (string, required): The phone number of the recipient.
\n
template_sid (string, required): The SID of the template to be used.
\n
data (object, required): The data to be included in the template message.
\n

Response

The response for this request is a JSON object with the following properties:

success (boolean): Indicates if the request was successful.
\n
message (string): A message related to the request.
\n
data (object): An object containing the message ID.
\n

JSON Schema

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"success\": {\n      \"type\": \"boolean\"\n    },\n    \"message\": {\n      \"type\": \"string\"\n    },\n    \"data\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"message_id\": {\n          \"type\": \"string\"\n        }\n      }\n    }\n  }\n}\n\n

\n","urlObject":{"path":["template-message"],"host":["https://unifiedway-api-in.allinonecentral.com/api/send"],"query":[],"variable":[]}},"response":[{"id":"27d27ca2-bcea-4b14-95ec-2d9a6c1d8f75","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"from_phone_number\":\"528436\",\r\n \"to_phone_number\":\"+918401324266\",\r\n \"template_sid\":\"HX17f2e6e585fc46a28cfb825dd2235ffb\",\r\n \"data\":{\r\n \"{{1}}\":\"Satya\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://unifiedway-api-in.allinonecentral.com/api/send/template-message"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Fri, 21 Jun 2024 06:29:47 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"117"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"ETag","value":"W/\"75-OexT017K1Odhtgd0hMWiQTi1H54\""}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Message is send successfully\",\n \"data\": {\n \"message_id\": \"sms97b4acaf208a41cdb5026d5265d94c08\"\n }\n}"},{"id":"ba5a1183-4dc1-4f7a-897d-869d42b4c58a","name":"Validation Error","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":""},"url":"https://unifiedway-api-in.allinonecentral.com/api/send/template-message"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0 (Ubuntu)"},{"key":"Date","value":"Fri, 21 Jun 2024 06:10:22 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"485"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"ETag","value":"W/\"1e5-9x9lESyTDTk3AYVH3canXCDeNb0\""}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message\": \"The body request validation failed.\",\n \"data\": [\n {\n \"type\": \"field\",\n \"msg\": \"The from phone number field is required.\",\n \"path\": \"from_phone_number\",\n \"location\": \"body\"\n },\n {\n \"type\": \"field\",\n \"msg\": \"The to phone number field is required.\",\n \"path\": \"to_phone_number\",\n \"location\": \"body\"\n },\n {\n \"type\": \"field\",\n \"msg\": \"The template sid field is required.\",\n \"path\": \"template_sid\",\n \"location\": \"body\"\n },\n {\n \"type\": \"field\",\n \"msg\": \"The data object field is required.\",\n \"path\": \"data\",\n \"location\": \"body\"\n }\n ]\n}"}],"_postman_id":"4e87d104-2428-48bc-aaf4-66cd6d660471"},{"name":"WhatsApp Message","id":"1c0f9f8a-eb09-4477-b3bf-25404b8bcb54","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":""},{"key":"password","value":""}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"from_phone_number","value":"+15557006177","type":"text"},{"key":"to_phone_number","value":"+918401324266","type":"text"},{"key":"template_name","value":"order_invoice_message","type":"text"},{"key":"language_code","value":"en","type":"text"},{"key":"body_data","value":"{\"{{1}}\" : \"Satya\",\"{{2}}\" : \"454545-45454\",\"{{3}}\" : \"$100\",\"{{4}}\" : \"2024-08-10\"}","type":"text"},{"key":"header_data","value":"{}","type":"text"},{"key":"file","type":"file","src":"/C:/Users/Rigel/Documents/PHP Developer - SN.pdf"}]},"url":"https://unifiedway-api-in.allinonecentral.com/api/send/whatsapp","description":"

Send WhatsApp Message

This endpoint allows you to send a WhatsApp message.

Request Body Parameters

from_phone_number (text): The phone number from which the message is sent.
\n
to_phone_number (text): The recipient's phone number.
\n
template_name (text): The name of the message template.
\n
language_code (text): The language code for the message and click here to view supported list.
\n
body_data (text): The body content of the message.
\n
header_data (text): The header data for the message.
\n
file (file): The file to be sent as an attachment (if any).
\n

Response

The response is in JSON format and has the following schema:

{\n  \"success\": true,\n  \"message\": \"\",\n  \"data\": {\n    \"message_id\": \"\"\n  }\n}\n\n

\n","urlObject":{"path":["whatsapp"],"host":["https://unifiedway-api-in.allinonecentral.com/api/send"],"query":[],"variable":[]}},"response":[{"id":"c42eede4-837f-442c-9615-4e1323715823","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"from_phone_number\":\"+15557004728\",\r\n \"to_phone_number\":\"+918401324266\",\r\n \"template_name\":\"user_verifcation\",\r\n \"language_code\":\"en\",\r\n \"data\":{\r\n \"{{1}}\":\"123456\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"https://unifiedway-api-in.allinonecentral.com/api/send/whatsapp"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"117"},{"key":"ETag","value":"W/\"75-7QF+Ih5Zaha9wuLLdsvf1DjWQhY\""},{"key":"Date","value":"Mon, 29 Jul 2024 06:39:34 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Message is send successfully\",\n \"data\": {\n \"message_id\": \"sms0cac8d9bbf0d4427b5f98ead70406086\"\n }\n}"},{"id":"424ddd5b-7f54-4291-99a1-36c0baa3e476","name":"Validation","originalRequest":{"method":"POST","header":[],"url":"https://unifiedway-api-in.allinonecentral.com/api/send/whatsapp"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"585"},{"key":"ETag","value":"W/\"249-/UKWBvXbX4vbC+raIKHNZePid4k\""},{"key":"Date","value":"Mon, 29 Jul 2024 06:36:55 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": false,\n \"message\": \"The body request validation failed.\",\n \"data\": [\n {\n \"type\": \"field\",\n \"msg\": \"The from phone number field is required.\",\n \"path\": \"from_phone_number\",\n \"location\": \"body\"\n },\n {\n \"type\": \"field\",\n \"msg\": \"The to phone number field is required.\",\n \"path\": \"to_phone_number\",\n \"location\": \"body\"\n },\n {\n \"type\": \"field\",\n \"msg\": \"The template name field is required.\",\n \"path\": \"template_name\",\n \"location\": \"body\"\n },\n {\n \"type\": \"field\",\n \"msg\": \"The language field is required.\",\n \"path\": \"language_code\",\n \"location\": \"body\"\n },\n {\n \"type\": \"field\",\n \"msg\": \"The data object field is required.\",\n \"path\": \"data\",\n \"location\": \"body\"\n }\n ]\n}"}],"_postman_id":"1c0f9f8a-eb09-4477-b3bf-25404b8bcb54"}],"id":"cf762c95-7b9a-438b-961c-f1a302fd75b8","_postman_id":"cf762c95-7b9a-438b-961c-f1a302fd75b8","description":""},{"name":"Report","item":[{"name":"Sent SMS","id":"a284655f-310d-4c3b-ac25-2fc8923b4fc6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"basic","basic":{"basicConfig":[{"key":"username","value":"{{username}}"},{"key":"password","value":"{{password}}"}]},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"message_id\":\"smsb8b23554af8e48ac923666d496a7e7e9\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://unifiedway-api-in.allinonecentral.com/api/send/message-report","description":"

Send Message Report

This endpoint is used to send a message report.

Request

Method: POST
URL: https://unifiedway-api-in.allinonecentral.com/api/send/message-report
Body:
- message_id (text, required): The ID of the message.
\n

Response

The response is in the form of a JSON schema:

{\n  \"success\": boolean,\n  \"message\": string,\n  \"data\": {\n    \"message_id\": string,\n    \"status\": string\n  }\n}\n

\n","urlObject":{"path":["message-report"],"host":["https://unifiedway-api-in.allinonecentral.com/api/send"],"query":[],"variable":[]}},"response":[{"id":"05e1f81f-d89c-4252-8e51-8cc57daf18bf","name":"Sent SMS","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"message_id\":\"smsb8b23554af8e48ac923666d496a7e7e9\"\r\n}","options":{"raw":{"language":"json"}}},"url":"https://unifiedway-api-in.allinonecentral.com/api/send/message-report"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"142"},{"key":"ETag","value":"W/\"8e-RpwS0MRDPDzNnTro46tLRzSdCQg\""},{"key":"Date","value":"Mon, 24 Jun 2024 07:42:41 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=5"}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Message report found successfully\",\n \"data\": {\n \"message_id\": \"smsb8b23554af8e48ac923666d496a7e7e9\",\n \"status\": \"Delivered\"\n }\n}"}],"_postman_id":"a284655f-310d-4c3b-ac25-2fc8923b4fc6"}],"id":"aaed4622-49da-4997-b8db-c95a5fafef3a","_postman_id":"aaed4622-49da-4997-b8db-c95a5fafef3a","description":""}],"event":[{"listen":"prerequest","script":{"id":"29095dd0-abab-4915-86bd-5ca5f47a21aa","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"3ea5155f-9a38-4a0f-893c-fab3e6036af8","type":"text/javascript","packages":{},"exec":[""]}}],"variable":[{"key":"url","value":"https://unifiedway-api-in.allinonecentral.com/api/","type":"string"}]}