{"info":{"_postman_id":"ac56a063-64ac-4328-bf90-ff563b79a558","name":"Cecula Sync","description":"

The Cecula Sync API consists of a set of endpoints for sending SMS and Call communication through your dedicated SIM Hosted on the Cecula Sync Cloud or Self-Hosted on the Cecula Sync App.

Authentication

Every request to Cecula Sync Cloud API requires Authentication. The first steps to take will be to login to the Cecula Sync Platform and Generate your API Key.

An API Key encapsulates your credentials and your Dedicated number. Therefore, there will be no need to specify originator when sending a message, making a call or any other request.

Each dedicated number you host on Cecula Sync Cloud requires a sperate API Key.

An API Key looks like this:

\n
CCL.BvDwEv6oQyq7-wT.390JYJYz8Y6NftIAgjLTPppW
\n

To use the API Key you set the Authorization headers like this:

\n
Authorization: Bearer CCL.BvDwEv6oQyq7-wT.390JYJYz8Y6NftIAgjLTPppW
\n

An attempt to make a request to a resource without providing authorization header or providing an invalid API Key will return HTTP 401 Unauthorized error.

An API Key should be stored secretly within your application. If at any time you feel your API Key has been compromised, you should immediately login to the Cecula Sync Platform and generate a new API Key.

Setting Up WebHooks

Webhooks are URLs where sms, calls logs and sms reports for your dedicated number will be sent. After you setup webhooks incoming resources for that number will be forwarded to the appropriate webhooks.

Although there are API endpoints for fetching Sent SMS Status Report, Inbound SMS, Inbound Call Reports and Outbound Call Reports - it is by far more efficient to provide a webhook where Cecula Sync will forward resources as they become available.

To setup webhooks, Login to the Cecula Sync Platform, navigate to Settings menu and click the Webhooks tab.

\n
For comprehensive guide (with examples and code snippets for your programming language) on How to Send SMS, Send Calls and other API Features, Refer to the API Reference section.
\n

Data Format For Each WebHook

All resources are sent as Input Streams in JSON format.

Inbound SMS Format

{\n    \"originator\":\"+2348183172770\",\n    \"receiver\":\"08176470634\",\n    \"message\":\"One love\",\n    \"timeReceived\":\"2020/02/01 07:37\"\n}\n

Sent SMS Report Format

{\n    \"messageId\":\"16276\",\n    \"originator\":\"08176470634\",\n    \"receiver\":\"2348183172770\",\n    \"status\":\"DELIVERED\",\n    \"sendTime\":\"2020/02/01 07:37\",\n    \"doneTime\":\"2020/02/01 07:37\"\n}\n

Inbound Call Notification Format

{\n    \"originator\":\"08183172770\",\n    \"receiver\":\"08176470634\",\n    \"callDuration\":\"0\",\n    \"callTime\":\"2020/02/02 01:08\"\n}\n

Outbound Call Status Format

{\n    \"callId\":\"2020012445\",\n    \"originator\":\"08176470634\",\n    \"receiver\":\"+2348183172770\",\n    \"status\": \"ANSWERED\",\n    \"callTime\":\"2020/02/01 08:01\"\n}\n

Parameters

The table below defines the fields that are used on Cecula Sync API.

Request 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

Field	Data Type	Meaning
receiver	String	The destination mobile number a call of sms will be terminated to
recipients	String	The destination of mobile numbers a message will be terminated to. Multiple numbers should be seperated with comma (,) Note: Currently, multiple receivers only applies for sms.
text	String	The body of the message to be sent or set in auto-responders. Text supports up to a maximum of 1530 characters.

Response 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\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\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

Field	Data Type	Meaning
receiver	String	The destination mobile number a call of sms will be terminated to
recipient	String	The destination mobile number an sms will be (or was) terminated to
message	String	The details of a returned statusCode
reports	Array	An array of message recipients objects. Each object has two properties recipient and trackingId
trackingId	Integer	A unique identifier assigned to a receiver for delivery tracking and reporting purpose
originator	String	The number a call of message is sent from. Your dedicated number in the case of Outbound Call or SMS. The other party's number in the case of an Inbound Call or SMS.
status	String	The state of a sent SMS or Call. See full list of statuses in the Statuses section
statusCode	String	Some request like Message Sending return a code which notifies you of the issue with broadcast or if message was successfully sent
callId	Integer	A unique identifier (similar to trackingId) assigned to a call receiver for tracking and reporting purpose.
callTime	DateTime	The time when a call was initiated (for outbound call) or number received call request (For Inbound Call)
callDuration	Integer	The length (in seconds) of an outbound or inbound call
sendTime	DateTime	The time when a message was broadcasted
doneTime	DateTime	The time when the final delivery report for message was received.
timeReceived	DateTime	The time when an Inbound SMS is received
balance	Double	Your Cecula Credit balance
subscriptionStatus	String	The status of your subscription
subscriptionPlan	String	The plan a your have subscribed to
expiryDate	DateTime	The date when your subscription will expire

Errors

Errors are Great. They make you see what's wrong with your integration. Errors are divided into HTTP Error and Sync Error.

HTTP Errors

The table below contains a list of other HTTP Errors you may encounter with the API.

\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

Error Code	Short Message	Interpretation
415	Unsupported Media Type	You have not set the Content-Type header to \"application/json\"
401	Unauthorized	API Key was not provided. To clear this error, set Authorization Header to Bearer {{your-api-key}}.
405	Method Not Allowed	You are sending request with the wrong HTTP METHOD

Sample HTTP Error Response

HTTP Errors are returned as JSON objects with following structure

{\n    \"errorCode\": 404,\n    \"errorMessage\": \"Requested resource not available or may have been moved\"\n}\n

Sync Errors

Sync Errors are returned when you encounter errors not related to your request but the content you have submitted to the API:

\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\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Error Code	Short Message	Interpretation
CE1000	Empty Fields	One or more required fields have not been submitted or were sent empty
CE1001	Invalid Fields	One or more fields contains an invalid data type
CE1100	Invalid Field	The referenced field contains an invalid data type
CE1102	Invalid Field	The length of data is either too long or too short
CE1103	Unregistered Originator	The originator (numeric or alphanumeric) being used has not been registered
CE1104	Unapproved Originator	The originator (numeric or alphanumeric) being used is pending approval
CE2000	Service Suspended	Your Sync Cloud Subscription has expired.
CE2001	Service Barred	Hosted SIM is barred from sending message or making call
CE3001	Insufficient Credit	Insufficient credit on Cecula Account/Wallet

Sample Sync Error Response

{\n    \"code\": \"CE1100\",\n    \"error\": \"Invalid Receiver. Receiver should be of format +2348050209037\"\n}\n

Statuses

Status Codes are codes returned when you query a Sync endpoint for Message or Call Status

SMS Statuses

\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

Response	Interpretation
DELIVERED	Message has been delivered to receiver's device
FAILED	Message could not be delivered to receiver's device
EXPIRED	Message could not be delivered to receiver after 24 hours
SENT	Message has been sent to telecoms network. Awaiting delivery confirmation
QUEUED	Message has not been sent to Operator

Call Statuses

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

Response	Interpretation
ANSWERED	Call was answered by the receiver
NOT ANSWERED	Call was not answered by receiver

API References

Click a reference folder from the left pane to expand.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Authentication","slug":"authentication"},{"content":"Setting Up WebHooks","slug":"setting-up-webhooks"},{"content":"Parameters","slug":"parameters"},{"content":"Errors","slug":"errors"},{"content":"Statuses","slug":"statuses"},{"content":"API References","slug":"api-references"}],"owner":"3869433","collectionId":"ac56a063-64ac-4328-bf90-ff563b79a558","publishedId":"SWTHaaiY","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2021-09-02T15:55:34.000Z"},"item":[{"name":"Calls","item":[{"name":"Send Missed Call","id":"33dd21f6-3cb8-4bf9-a8ed-cb97ecbafb7c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Authorization header generated by Postman.","key":"Authorization","value":"Bearer {{your-api-key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"receiver\": \"{{recipient-number}}\"\n}"},"url":"https://cecula.com/sync/api/flash-number","description":"

Use this endpoint to send a missed call to a phone to one recipient at a time. Call will be terminated by the dialler immediately the receiver answers.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{your-api-key}}"}]},"isInherited":true,"source":{"_postman_id":"ac56a063-64ac-4328-bf90-ff563b79a558","id":"ac56a063-64ac-4328-bf90-ff563b79a558","name":"Cecula Sync","type":"collection"}},"urlObject":{"protocol":"https","path":["sync","api","flash-number"],"host":["cecula","com"],"query":[],"variable":[]}},"response":[{"id":"7d5ef25a-7e0e-4de7-b549-6c144a842ae5","name":"Send Missed Call using International Number Format","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{your-api-key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"receiver\": \"+2348183172770\"\n}","options":{"raw":{"language":"json"}}},"url":"https://cecula.com/sync/api/flash-number"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 07 Feb 2020 21:29:41 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.3.14"},{"key":"X-Powered-By","value":"PHP/7.3.14"},{"key":"Content-Length","value":"93"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"1801\",\n \"receiver\": \"+2348176470634\",\n \"trackingId\": 2020012460,\n \"message\": \"Successful\"\n}"},{"id":"e59ada98-ef58-45a6-85ae-db4460d635bb","name":"Send Missed Call using Local Number Format","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{your-api-key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"receiver\": \"08050209037\"\n}","options":{"raw":{"language":"json"}}},"url":"https://cecula.com/sync/api/flash-number"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 07 Feb 2020 21:32:57 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.3.14"},{"key":"X-Powered-By","value":"PHP/7.3.14"},{"key":"Content-Length","value":"90"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"1801\",\n \"receiver\": \"08050209037\",\n \"trackingId\": 2020012461,\n \"message\": \"Successful\"\n}"}],"_postman_id":"33dd21f6-3cb8-4bf9-a8ed-cb97ecbafb7c"},{"name":"Dialled Call Status","id":"476144d6-37cf-4e4b-8783-f776f4566755","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{your-api-key}}","type":"text"}],"url":"https://cecula.com/sync/api/dialled-call-status/{{call-track-id}}","description":"

Use this endpoint to fetch the status of a dialled call.

Use this endpoint to fetch new missed calls.

Note: This endpoint will return a recordset only once. Returned records are immediately removed and will no longer be available.

Use this endpoint to set auto-response message

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{your-api-key}}"}]},"isInherited":true,"source":{"_postman_id":"ac56a063-64ac-4328-bf90-ff563b79a558","id":"ac56a063-64ac-4328-bf90-ff563b79a558","name":"Cecula Sync","type":"collection"}},"urlObject":{"protocol":"https","path":["sync","api","set-call-autoresponse"],"host":["cecula","com"],"query":[],"variable":[]}},"response":[{"id":"422672c3-84ef-4035-abfa-11e44eda1abb","name":"Unset Auto-Response","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{your-api-key}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"text\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://cecula.com/sync/api/set-call-autoresponse"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 08 Feb 2020 17:24:55 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.3.14"},{"key":"X-Powered-By","value":"PHP/7.3.14"},{"key":"Content-Length","value":"20"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Success\"\n}"},{"id":"9abee7c2-31e1-4a01-b833-57c82e7912e5","name":"Set Auto-Response","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{your-api-key}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"text\": \"This is an SMS-Only Number. Call our support on 08050209037\"\n}","options":{"raw":{"language":"json"}}},"url":"https://cecula.com/sync/api/set-call-autoresponse"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 08 Feb 2020 17:27:19 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.3.14"},{"key":"X-Powered-By","value":"PHP/7.3.14"},{"key":"Content-Length","value":"20"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Success\"\n}"},{"id":"cf0df00c-86d1-439f-bacc-f67a49d08166","name":"Unset Auto-Response","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{your-api-key}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"text\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://cecula.com/sync/api/set-call-autoresponse"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 08 Feb 2020 17:26:02 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.3.14"},{"key":"X-Powered-By","value":"PHP/7.3.14"},{"key":"Content-Length","value":"20"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Success\"\n}"}],"_postman_id":"dc6da9f9-0523-44c1-bc95-1a8a0e564450"}],"id":"4690316f-38b2-4bd9-86ac-bd5dc74e0f2c","description":"

This is a collection of call functionalities

\n","event":[{"listen":"prerequest","script":{"id":"635341ae-1f59-45de-b518-262eee572f3f","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"f819d7c4-17ed-4e19-bab1-0ee8c8180af3","type":"text/javascript","exec":[""]}}],"_postman_id":"4690316f-38b2-4bd9-86ac-bd5dc74e0f2c","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{your-api-key}}"}]},"isInherited":true,"source":{"_postman_id":"ac56a063-64ac-4328-bf90-ff563b79a558","id":"ac56a063-64ac-4328-bf90-ff563b79a558","name":"Cecula Sync","type":"collection"}}},{"name":"SMS","item":[{"name":"Send SMS","id":"1104c8f5-ff73-4c1c-9b80-9f8a5501b7fe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{your-api-key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"text\": \"{{message}}\",\n\t\"recipients\": \"{{recipient-number}},{{recipient-number2}}\"\n}"},"url":"https://cecula.com/sync/api/send-sms","description":"

Use this endpoint to send sms to single or multiple recipients. Recipient number should be in international format. eg. +2349090000246

A successfully sent message will return status 1801 and a reports array which comprises of id and recipient attribute each as seen in the example below.

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{your-api-key}}"}]},"isInherited":true,"source":{"_postman_id":"ac56a063-64ac-4328-bf90-ff563b79a558","id":"ac56a063-64ac-4328-bf90-ff563b79a558","name":"Cecula Sync","type":"collection"}},"urlObject":{"protocol":"https","path":["sync","api","send-sms"],"host":["cecula","com"],"query":[],"variable":[]}},"response":[{"id":"37097710-8006-4f15-9c94-8e012720b5b2","name":"Send SMS to Multiple Recipients","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{your-api-key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"text\": \"Hello World\",\n\t\"recipients\": \"2348176470634,2348050209037\"\n}","options":{"raw":{"language":"json"}}},"url":"https://cecula.com/sync/api/send-sms"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 07 Feb 2020 21:28:47 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.3.14"},{"key":"X-Powered-By","value":"PHP/7.3.14"},{"key":"Content-Length","value":"134"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"1801\",\n \"report\": [\n {\n \"recipient\": \"2348176470634\",\n \"trackingId\": 16334\n },\n {\n \"recipient\": \"2348050209037\",\n \"trackingId\": 16335\n }\n ],\n \"response\": \"Successful\"\n}"},{"id":"63277c66-96e6-4466-8e7b-e5101d8b81c4","name":"Send SMS to Single Number","originalRequest":{"method":"POST","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{your-api-key}}","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"text\": \"Hello World\",\n\t\"recipients\": \"2348176470634\"\n}","options":{"raw":{"language":"json"}}},"url":"https://cecula.com/sync/api/send-sms"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 07 Feb 2020 21:27:20 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.3.14"},{"key":"X-Powered-By","value":"PHP/7.3.14"},{"key":"Content-Length","value":"93"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"1801\",\n \"report\": [\n {\n \"recipient\": \"2348176470634\",\n \"trackingId\": 16329\n }\n ],\n \"response\": \"Successful\"\n}"}],"_postman_id":"1104c8f5-ff73-4c1c-9b80-9f8a5501b7fe"},{"name":"Sent SMS Status","id":"7d9959ca-b4b7-4af3-8ad3-9f9236eb8998","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{your-api-key}}","type":"text"}],"url":"https://cecula.com/sync/api/sent-sms-status/{{sms-track-id}}","description":"

Use this endpoint to query for the status of a sent SMS Message.

Use this endpoint to query for new incoming SMS Message.

Note: This endpoint will return a recordset only once. Returned records are immediately removed and will no longer be available.

Use this endpoint to set auto-response message

\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{your-api-key}}"}]},"isInherited":true,"source":{"_postman_id":"ac56a063-64ac-4328-bf90-ff563b79a558","id":"ac56a063-64ac-4328-bf90-ff563b79a558","name":"Cecula Sync","type":"collection"}},"urlObject":{"protocol":"https","path":["sync","api","set-sms-autoresponse"],"host":["cecula","com"],"query":[],"variable":[]}},"response":[{"id":"923e382d-c7d5-478d-9a5b-ad9b95b9c73a","name":"Set Auto-Response Message","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{your-api-key}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"text\": \"Thank you for Subscribing for our Information Service\"\n}","options":{"raw":{"language":"json"}}},"url":"https://cecula.com/sync/api/set-sms-autoresponse"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 08 Feb 2020 17:22:24 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.3.14"},{"key":"X-Powered-By","value":"PHP/7.3.14"},{"key":"Content-Length","value":"20"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Success\"\n}"},{"id":"f7255b79-b581-4af8-8d2b-4f8b8cc3fac5","name":"Unset Auto-Response","originalRequest":{"method":"PATCH","header":[{"key":"Authorization","value":"Bearer {{your-api-key}}","type":"text"},{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"text\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"https://cecula.com/sync/api/set-sms-autoresponse"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Sat, 08 Feb 2020 17:20:49 GMT"},{"key":"Server","value":"Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips PHP/7.3.14"},{"key":"X-Powered-By","value":"PHP/7.3.14"},{"key":"Content-Length","value":"20"},{"key":"Keep-Alive","value":"timeout=5, max=100"},{"key":"Connection","value":"Keep-Alive"},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"Success\"\n}"}],"_postman_id":"ac82ee13-d425-48be-a20b-f437f5e74a63"}],"id":"4e330491-b13e-473f-9173-36ff1a3796d4","description":"

A collection of messaging functionalities

\n","_postman_id":"4e330491-b13e-473f-9173-36ff1a3796d4","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{your-api-key}}"}]},"isInherited":true,"source":{"_postman_id":"ac56a063-64ac-4328-bf90-ff563b79a558","id":"ac56a063-64ac-4328-bf90-ff563b79a558","name":"Cecula Sync","type":"collection"}}},{"name":"Account","item":[{"name":"Get Cecula Balance","id":"916767da-ba12-4ece-ab86-40a8299c1fd2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"Bearer {{your-api-key}}","type":"text"}],"url":"https://cecula.com/sync/api/cecula-balance","description":"

This endpoint is used to fetch User's Cecula Balance

This Endpoint is used to fetch subscription Status

This endpoint is used to expose the mobile number behind an API Key.

Use this endpoint to setup Dynamic Webhooks. In addition to the webhook configured on Cecula Sync Platform, you can programmatically setup Dynamic Webhooks for one-time use. This webhook does not appear reflect on the platform but is used internally.

Dynamic Webhooks can be used to listen for and route incoming sms or call from a specific mobile number to your application endpoint.

Request 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

Field	Data Type	Meaning
url	String	The webhook url
originMsisdn	String	Number to listen for sms or call from
trafficType	String	SMS or CALL
validityPeriod	Int	Wait time in seconds before dynamic webhook record is destroyed.

","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{your-api-key}}"}]},"isInherited":true,"source":{"_postman_id":"ac56a063-64ac-4328-bf90-ff563b79a558","id":"ac56a063-64ac-4328-bf90-ff563b79a558","name":"Cecula Sync","type":"collection"}},"urlObject":{"protocol":"https","path":["sync","api","set-dynamic-webhook"],"host":["cecula","com"],"query":[],"variable":[]}},"response":[],"_postman_id":"353607aa-370a-40d6-94b9-b9da43861e86"}],"id":"d99c46d7-4825-41e0-87df-798409c5eccc","description":"

This collection of endpoints handle account related issue.

\n","_postman_id":"d99c46d7-4825-41e0-87df-798409c5eccc","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{your-api-key}}"}]},"isInherited":true,"source":{"_postman_id":"ac56a063-64ac-4328-bf90-ff563b79a558","id":"ac56a063-64ac-4328-bf90-ff563b79a558","name":"Cecula Sync","type":"collection"}}},{"name":"Management","item":[{"name":"SIM Status","id":"8494cc5a-e4f5-47d5-a5b3-46eb9c3ba413","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{your-api-key}}","type":"text"}],"body":{"mode":"raw","raw":""},"url":"https://cecula.com/sync/api/management/sim-status","description":"

This endpoint is used to fetch the status of a SIM.

This endpoint is used to refresh a SIM if it get frozen or becomes slow

This is a collection of endpoints for Managing the Hosted SIM and Viewing the State of the hosted SIM.

\n","_postman_id":"474cb71e-e12b-4be7-a099-d635ef22aff4","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{your-api-key}}"}]},"isInherited":true,"source":{"_postman_id":"ac56a063-64ac-4328-bf90-ff563b79a558","id":"ac56a063-64ac-4328-bf90-ff563b79a558","name":"Cecula Sync","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{your-api-key}}"}]}},"event":[{"listen":"prerequest","script":{"id":"396cc0ab-f9ea-4310-9957-ddb9e621df92","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"92650e77-c5bc-41b8-a56e-257e2de8794a","type":"text/javascript","exec":[""]}}]}