The world's greatest SMS API
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://www.zoomconnect.com/app
auth: a p i k e y
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
The world's greatest SMS API
| method | path | what the vendor says it does |
|---|---|---|
GET | /api/rest/v1/account/balance | balance Returns your account's credit balance account |
GET | /api/rest/v1/account/statistics | statistics Returns data from the statistics report. Note that by default the statistics shown are based on the |
POST | /api/rest/v1/account/transfer | transfer Transfers credits between two users in the same team. The account email address fields as well as the |
GET | /api/rest/v1/account/user | search Find a user for a particular email address account |
PUT | /api/rest/v1/account/user | create Creates a new sub-account in your team. The following fields are required firstname, lastname, email ad |
GET | /api/rest/v1/account/user/{userId} | getUser Gets a user from a given user id account |
POST | /api/rest/v1/account/user/{userId} | update Updates a sub-account in your team. The following fields can be updated firstname, lastname, contact nu |
GET | /api/rest/v1/contacts/all | all Returns all contacts contacts |
POST | /api/rest/v1/contacts/create | create Creates a contact contacts |
GET | /api/rest/v1/contacts/{contactId} | get Returns details for a single contact contacts |
POST | /api/rest/v1/contacts/{contactId} | update Updates a contact contacts |
DELETE | /api/rest/v1/contacts/{contactId} | delete Deletes a contact contacts |
GET | /api/rest/v1/contacts/{contactId}/addFromGroup/{groupId} | removeFromGroup Remove a contact from a group contacts |
POST | /api/rest/v1/contacts/{contactId}/addFromGroup/{groupId} | removeFromGroup Remove a contact from a group contacts |
GET | /api/rest/v1/contacts/{contactId}/addToGroup/{groupId} | addToGroup Add a contact to a group contacts |
POST | /api/rest/v1/contacts/{contactId}/addToGroup/{groupId} | addToGroup Add a contact to a group contacts |
GET | /api/rest/v1/groups/all | all Returns all groups groups |
POST | /api/rest/v1/groups/create | create Create a group groups |
GET | /api/rest/v1/groups/{groupId} | get Returns details for a single group groups |
POST | /api/rest/v1/groups/{groupId} | update Update a group groups |
DELETE | /api/rest/v1/groups/{groupId} | delete Deletes a group groups |
GET | /api/rest/v1/groups/{groupId}/addContact/{contactId} | addContact Add a contact to a group groups |
POST | /api/rest/v1/groups/{groupId}/addContact/{contactId} | addContact Add a contact to a group groups |
GET | /api/rest/v1/groups/{groupId}/removeContact/{contactId} | removeContact Remove a contact from a group groups |
POST | /api/rest/v1/groups/{groupId}/removeContact/{contactId} | removeContact Remove a contact from a group groups |
GET | /api/rest/v1/messages/all | all Returns all messages messages |
POST | /api/rest/v1/messages/analyse/full | analyse-full Returns full analysis of message messages |
POST | /api/rest/v1/messages/analyse/message-credit-cost | analyse-message-credit-cost Returns the number of credit which would be required to send the request message t |
POST | /api/rest/v1/messages/analyse/message-encoding | analyse-message-encoding Returns the message encoding that would be required to send the requested message mes |
POST | /api/rest/v1/messages/analyse/message-length | analyse-message-length Returns the number of characters the requested message consists of messages |
POST | /api/rest/v1/messages/analyse/message-length-within-max-allowed | analyse- Returns details for a single message messages |
POST | /api/rest/v1/messages/analyse/number-of-messages | analyse-number-of-messages Returns the number of SMS parts which would be sent when sending the requested mess |
GET | /api/rest/v1/messages/{messageId} | get Returns details for a single message messages |
DELETE | /api/rest/v1/messages/{messageId} | delete Deletes a message messages |
POST | /api/rest/v1/messages/{messageId}/markRead | markRead Marks a message as read messages |
PUT | /api/rest/v1/messages/{messageId}/markRead | markRead Marks a message as read messages |
POST | /api/rest/v1/messages/{messageId}/markUnread | markUnread Marks a message as unread messages |
PUT | /api/rest/v1/messages/{messageId}/markUnread | markUnread Marks a message as unread messages |
GET | /api/rest/v1/sms/send | send Returns an example of the data to POST to send a single message. sms |
POST | /api/rest/v1/sms/send | send Sends a single message. The recipientNumber and message fields are required. All other fields are optiona |
and 14 more operation(s) in this specification, all searchable.
specification origin: https://www.zoomconnect.com/zoom/api-docs
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.