Skip to main content

​
Get an API key

YCloud authenticates server-side requests with API keys. Create or view an API key in Dashboard > Developers > API keys, then send it in the X-API-Key request header.
Keep API keys on your server. Never commit them to a repository or expose them in browser or mobile application code.
If you prefer an SDK, see the available languages and installation instructions in YCloud Developers.

​
Explore the endpoint

Open Send an SMS for the complete request parameters, response schema, and interactive request builder. For the end-to-end integration workflow and delivery considerations, see Send an SMS.

​
Handle the response

A 2xx response means YCloud accepted the request. It does not necessarily mean that the SMS reached the recipient. Store the returned message ID and correlate it with retrieval results or webhook events to track delivery.

​
Handle errors

Error responses include three fields:
  • code is the stable, machine-readable error identifier.
  • message explains the error to developers.
  • requestId helps YCloud support troubleshoot a request.
Use the stable error identifier in your application logic. Do not match the developer-facing explanation. See Handle errors for the response format and retry guidance.