The SMS API is a part of the Ocelot API, which allows you to send a batch of 1:1 texts in a single request. Once a batch is accepted, Ocelot API will repeatedly call your own SMS webhook URL to notify you about the delivery status change of each SMS.
Ocelot SMS API is provided in the form of a simple REST API that uses Basic Authentication and uses JSON payloads for simplicity.
The school controls the batch being sent and process delivery events for each individual message.
The Ocelot API handles validating the batch, checking recipients' phone numbers for opt-outs, registering the resulting 1:1 texts in the admin portal, and the delivery of the SMS text message to the recipients.
The SMS API is also integrated with the admin portal. Every 1:1 text is immediately available in the admin portal as if it was sent manually.
To set up the SMS API 1:1 Texting feature, you will need access to our API documentation. To request this information you will need to complete a Non-Disclosure Agreement (NDA).
Please submit a Support Ticket with the following information:
- School name
- The physical address of the school
- Email and title of the person signing the NDA
The NDA will be delivered by email for a digital signature.