www.zoomconnect.com
The world's greatest SMS API
Communication#openapi#messaging#marketing
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
The world's greatest SMS API
Endpoints 54
account
- GETbalance
/api/rest/v1/account/balanceReturns your account's credit balance - GETstatistics
/api/rest/v1/account/statistics?from=2024-01-01T00:00:00Z&to=2024-01-01T00:00:00Z&userEmailAddress=string&campaign=string&includeRefundedAndOptout=true&calculateCreditValue=trueReturns data from the statistics report. Note that by default the statistics shown are based on the number of messages, use the calculateCreditValue should… - POSTtransfer
/api/rest/v1/account/transferTransfers credits between two users in the same team. The <i>account email address</i> fields as well as the <i>number of credits to transfer</i> are required. - GETsearch
/api/rest/v1/account/user?searchEmail=stringFind a user for a particular email address - PUTcreate
/api/rest/v1/account/userCreates a new sub-account in your team. The following fields are required <i>firstname, lastname, email address, contact number</i> and <i>password.</i> - GETgetUser
/api/rest/v1/account/user/:userIdGets a user from a given user id - POSTupdate
/api/rest/v1/account/user/:userIdUpdates a sub-account in your team. The following fields can be updated <i>firstname, lastname, contact number</i> and <i>password.</i>
contacts
- GETall
/api/rest/v1/contacts/allReturns all contacts - POSTcreate
/api/rest/v1/contacts/createCreates a contact - GETget
/api/rest/v1/contacts/:contactIdReturns details for a single contact - POSTupdate
/api/rest/v1/contacts/:contactIdUpdates a contact - DELETEdelete
/api/rest/v1/contacts/:contactIdDeletes a contact - GETremoveFromGroup
/api/rest/v1/contacts/:contactId/addFromGroup/:groupIdRemove a contact from a group - POSTremoveFromGroup
/api/rest/v1/contacts/:contactId/addFromGroup/:groupIdRemove a contact from a group - GETaddToGroup
/api/rest/v1/contacts/:contactId/addToGroup/:groupIdAdd a contact to a group - POSTaddToGroup
/api/rest/v1/contacts/:contactId/addToGroup/:groupIdAdd a contact to a group
groups
- GETall
/api/rest/v1/groups/allReturns all groups - POSTcreate
/api/rest/v1/groups/createCreate a group - GETget
/api/rest/v1/groups/:groupIdReturns details for a single group - POSTupdate
/api/rest/v1/groups/:groupIdUpdate a group - DELETEdelete
/api/rest/v1/groups/:groupIdDeletes a group - GETaddContact
/api/rest/v1/groups/:groupId/addContact/:contactIdAdd a contact to a group - POSTaddContact
/api/rest/v1/groups/:groupId/addContact/:contactIdAdd a contact to a group - GETremoveContact
/api/rest/v1/groups/:groupId/removeContact/:contactIdRemove a contact from a group - POSTremoveContact
/api/rest/v1/groups/:groupId/removeContact/:contactIdRemove a contact from a group
messages
- GETall
/api/rest/v1/messages/all?pageSize=100&page=1&type=OUTBOUND&status=SCHEDULED&fromDateTimeSent=2024-01-01T00:00:00Z&toDateTimeSent=2024-01-01T00:00:00Z&fromDateTimeReceived=2024-01-01T00:00:00Z&toDateTimeReceived=2024-01-01T00:00:00Z&fromNumber=string&toNumber=string&message=string&campaign=string&dataField=string&deleted=true&read=true&repliesToMessageId=stringReturns all messages - POSTanalyse-full
/api/rest/v1/messages/analyse/fullReturns full analysis of message - POSTanalyse-message-credit-cost
/api/rest/v1/messages/analyse/message-credit-costReturns the number of credit which would be required to send the request message to the requested recipient number - POSTanalyse-message-encoding
/api/rest/v1/messages/analyse/message-encodingReturns the message encoding that would be required to send the requested message - POSTanalyse-message-length
/api/rest/v1/messages/analyse/message-lengthReturns the number of characters the requested message consists of - POSTanalyse-
/api/rest/v1/messages/analyse/message-length-within-max-allowedReturns details for a single message - POSTanalyse-number-of-messages
/api/rest/v1/messages/analyse/number-of-messagesReturns the number of SMS parts which would be sent when sending the requested message - GETget
/api/rest/v1/messages/:messageIdReturns details for a single message - DELETEdelete
/api/rest/v1/messages/:messageIdDeletes a message - PUTmarkRead
/api/rest/v1/messages/:messageId/markReadMarks a message as read - POSTmarkRead
/api/rest/v1/messages/:messageId/markReadMarks a message as read - PUTmarkUnread
/api/rest/v1/messages/:messageId/markUnreadMarks a message as unread - POSTmarkUnread
/api/rest/v1/messages/:messageId/markUnreadMarks a message as unread
sms
- GETsend
/api/rest/v1/sms/sendReturns an example of the data to POST to send a single message. - POSTsend
/api/rest/v1/sms/sendSends a single message. The <i>recipientNumber</i> and <i>message</i> fields are required. All other fields are optional. - GETsend-bulk
/api/rest/v1/sms/send-bulkReturns an example of the data to POST to send multiple messages in one transaction. - POSTsend-bulk
/api/rest/v1/sms/send-bulkSend multiple messages in one transaction. - GETsend-url-parameters
/api/rest/v1/sms/send-url-parameters?recipientNumber=string&message=string&dateToSend=2024-01-01T00:00:00Z&campaign=string&dataField=stringSend a single message using URL parameters.The <i>recipientNumber</i> and <i>message</i> parameters are required. All other parameters are optional. - POSTsend-url-parameters
/api/rest/v1/sms/send-url-parameters?recipientNumber=string&message=string&dateToSend=2024-01-01T00:00:00Z&campaign=string&dataField=stringSend a single message using URL parameters.The <i>recipientNumber</i> and <i>message</i> parameters are required. All other parameters are optional. - GETsend-url
/api/rest/v1/sms/send-url/:token?recipientNumber=string&message=string&dateToSend=2024-01-01T00:00:00Z&campaign=string&dataField=stringSend a single message using your unique URL without having to authenticate using your email address or REST API token. The token required is the URL Sending… - POSTsend-url
/api/rest/v1/sms/send-url/:token?recipientNumber=string&message=string&dateToSend=2024-01-01T00:00:00Z&campaign=string&dataField=stringSend a single message using your unique URL without having to authenticate using your email address or REST API token. The token required is the URL Sending…
templates
- GETall
/api/rest/v1/templates/allReturns all templates - GETget
/api/rest/v1/templates/:templateIdReturns details for a single template - DELETEdelete
/api/rest/v1/templates/:templateIdDeletes a template
voice
- GETall
/api/rest/v1/voice/all?pageSize=100&page=1&status=SCHEDULED&fromDateTimeSent=2024-01-01T00:00:00Z&toDateTimeSent=2024-01-01T00:00:00Z&toNumber=string&message=string&campaign=string&dataField=string&deleted=trueReturns all voice messages - POSTsingle-audio
/api/rest/v1/voice/single-audio?recipientNumber=string&campaign=string&dataField=string&retryCount=0&retryMinimumInterval=0&retryMaximumInterval=0Send a single audio voice message to one recipient. Note, Content-Type header must be set to multipart/form-data for this request. - POSTsingle-text
/api/rest/v1/voice/single-textSend a single text voice message to one recipient - GETget
/api/rest/v1/voice/:messageIdReturns details for a single message - DELETEdelete
/api/rest/v1/voice/:messageIdDeletes a message
API details
- Base URL
https://www.zoomconnect.com/app- Authentication
- An API key in the email header
An API key in the token header - Operations
- 54 operations on 35 pathsPOST 24GET 22DELETE 5PUT 3
- Main resources
- messages 13contacts 9groups 9sms 8account 7voice 5templates 3
- Response formats
application/jsonapplication/xml- Description format
- Swagger 2.0, API version
1 - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the www.zoomconnect.com in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the www.zoomconnect.com collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the email header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “balance” (GET /api/rest/v1/account/balance), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the www.zoomconnect.com?
The world's greatest SMS API It is listed under Communication and has 54 endpoints.
Who publishes the www.zoomconnect.com?
It is listed from Zoomconnect's public API description (an OpenAPI document), not published by Zoomconnect on Swastik Codes. Anyone who controls zoomconnect.com can claim the profile by adding a DNS TXT record.
What is the base URL of the www.zoomconnect.com?
Requests go to https://www.zoomconnect.com/app. Endpoint paths are added to this base URL.
How do I authenticate with the www.zoomconnect.com?
It accepts 2 methods: an API key in the email header; an API key in the token header.
How many endpoints does the www.zoomconnect.com have?
54 operations on 35 paths (24 POST, 22 GET, 5 DELETE, 3 PUT). The largest groups are messages, contacts, groups, sms.
Is forking the www.zoomconnect.com free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.