{"info":{"_postman_id":"5999c9de-97d0-434a-89c9-774bbb853b85","name":"SMS Streams API Documentation","description":"

Introduction

This Postman collection provides a set of API endpoints for interacting with the CommPeak SMS Streams API service. It is designed for developers, QA engineers, and other stakeholders involved in SMS-based communication services. You can use this collection to send SMS messages, monitor SMS streams, and perform other related operations.

Global Parameters

In this section, we will discuss any parameters that are common across multiple requests.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter Name	Description	Type	Required
Authorization	Your API key for authenticating the request.	Header	Yes

To get your API key, sign up or log in via https://my.commpeak.com and create an API key for SMS Streams API

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"14428619","collectionId":"5999c9de-97d0-434a-89c9-774bbb853b85","publishedId":"2s9Y5Zw2iQ","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2023-09-04T07:32:09.000Z"},"item":[{"name":"Send message","id":"6d392ac5-1b21-4b9a-9bd5-fc64ba0ec1d8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"messages\": [\r\n {\r\n \"internal_id\": \"1003\",\r\n \"sender\": \"GLOBAL\",\r\n \"recipient_phone\": \"972524265292\",\r\n \"message_content\": \"test message 1\" \r\n } ,\r\n {\r\n \"internal_id\": \"1004\",\r\n \"sender\": \"GLOBAL\",\r\n \"recipient_phone\": \"972545330008\",\r\n \"message_content\": \"test message 2\" \r\n }\r\n ]\r\n}\r\n"},"url":"https://sendsms.commpeak.com/simple_send/","description":"

Headers:

Authorization: This is an authorization token that verifies your access to the API. Please fill this with your actual token when making requests.
Content-Type: This should always be set to application/json as the API accepts request data in JSON format.

Request Body:
The request body should be a JSON object with a messages key that contains an array of message objects. Each message object should have the following keys:

internal_id: This is an identifier for the message. It should be unique for each message.
sender: This is the sender’s identifier. It could be a name, phone number, or any other identifier.
recipient_phone: This is the phone number of the recipient of the message.
message_content: This is the actual content of the message.

EndFragment

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":true,"source":{"_postman_id":"5999c9de-97d0-434a-89c9-774bbb853b85","id":"5999c9de-97d0-434a-89c9-774bbb853b85","name":"SMS Streams API Documentation","type":"collection"}},"urlObject":{"protocol":"https","path":["simple_send",""],"host":["sendsms","commpeak","com"],"query":[],"variable":[]}},"response":[{"id":"c08e17fb-aae8-405b-b2f2-5fb4eaae1499","name":"Send message - success","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"YOUR_API_KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"messages\": [\r\n {\r\n \"internal_id\": \"1003\",\r\n \"sender\": \"GLOBAL\",\r\n \"recipient_phone\": \"972524265292\",\r\n \"message_content\": \"test message 1\" \r\n } ,\r\n {\r\n \"internal_id\": \"1004\",\r\n \"sender\": \"972524265292\",\r\n \"recipient_phone\": \"972545330008\",\r\n \"message_content\": \"test message 2\" \r\n }\r\n ]\r\n}\r\n"},"url":"https://sendsms.commpeak.com/simple_send/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 23 Aug 2023 13:28:18 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"7fb3b2a2ea4671a8-LHR"},{"key":"Content-Encoding","value":"gzip"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"task_id\": \"251a4cfb-f098-4a84-83a1-66f6273bbb1d\",\n \"messages\": [\n {\n \"internal_id\": \"1003\",\n \"message_uuid\": \"0562f2aa-5945-4f41-824a-b774fc2e2b2a\",\n \"error\": null\n },\n {\n \"internal_id\": \"1004\",\n \"message_uuid\": \"ed8258f4-43f4-4873-8dc3-49989940edf5\",\n \"error\": null\n }\n ]\n}"},{"id":"1f095526-ec16-4c0c-aff1-dd5eaa4ff7cb","name":"Send message - error - not authenticated","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"YOUR_API_KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"messages\": [\r\n {\r\n \"internal_id\": \"1003\",\r\n \"sender\": \"GLOBAL\",\r\n \"recipient_phone\": \"972524265292\",\r\n \"message_content\": \"test message 1\" \r\n } ,\r\n {\r\n \"internal_id\": \"1004\",\r\n \"sender\": \"972524265292\",\r\n \"recipient_phone\": \"972545330008\",\r\n \"message_content\": \"test message 2\" \r\n }\r\n ]\r\n}\r\n"},"url":"https://sendsms.commpeak.com/simple_send/"},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 23 Aug 2023 13:35:20 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"30"},{"key":"Connection","value":"keep-alive"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"7fb3bcf39f5e06fd-LHR"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"detail\": \"Not authenticated\"\n}"},{"id":"debca3d6-bf1b-4665-b1ce-825e0314fbfe","name":"Send message - error - rate limit","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"YOUR_API_KEY","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"messages\": [\r\n {\r\n \"internal_id\": \"1003\",\r\n \"sender\": \"GLOBAL\",\r\n \"recipient_phone\": \"972524265292\",\r\n \"message_content\": \"test message 1\" \r\n } ,\r\n {\r\n \"internal_id\": \"1004\",\r\n \"sender\": \"972524265292\",\r\n \"recipient_phone\": \"972545330008\",\r\n \"message_content\": \"test message 2\" \r\n }\r\n ]\r\n}\r\n"},"url":"https://sendsms.commpeak.com/simple_send/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sun, 27 Aug 2023 11:49:41 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"CF-Cache-Status","value":"DYNAMIC"},{"key":"Server","value":"cloudflare"},{"key":"CF-RAY","value":"7fd417b6c8c18fec-FRA"},{"key":"Content-Encoding","value":"gzip"},{"key":"alt-svc","value":"h3=\":443\"; ma=86400"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": true,\n \"task_id\": \"ad340f18-e91d-4975-bd6a-efa0cd82a7e3\",\n \"messages\": [\n {\n \"internal_id\": \"1003\",\n \"message_uuid\": null,\n \"error\": \"RATE_LIMIT\"\n }\n ]\n}"}],"_postman_id":"6d392ac5-1b21-4b9a-9bd5-fc64ba0ec1d8"},{"name":"message status","id":"c3439458-0d70-4dfd-aab6-0a02e9d9cc62","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]},"isInherited":false},"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"message_uuids\": [\r\n \"e6b7ae60-6bbc-4db5-bfe4-7c9af27b8bdc\",\r\n \"81e766af-06eb-4676-ac83-0ca32b8aff85\"\r\n ]\r\n}\r\n"},"url":"https://sendsms.commpeak.com/messages_status/","description":"

This method allows you to check an existing single/bulk SMS request based on \"task_id\"

\n","urlObject":{"protocol":"https","path":["messages_status",""],"host":["sendsms","commpeak","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c3439458-0d70-4dfd-aab6-0a02e9d9cc62"}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"Authorization"},{"key":"value","value":""}]}},"event":[{"listen":"prerequest","script":{"id":"13b474f9-055c-4014-82b4-42c8711f8be9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"96d5011a-2db0-4aba-9a9b-f325d14a31eb","type":"text/javascript","exec":[""]}}]}