Coming from Twilio

#Change two lines

• Host: https://api.twilio.com becomes https://api.tryready.com.
• Credentials: keep Basic auth. The username can be your Account SID or anything else. The password is your Ready API key (rsms_...) in place of the Auth Token. The key alone decides the account: Ready ignores the username and the {AccountSid} in the path, and echoes it back as account_sid.

curl -X POST "https://api.tryready.com/2010-04-01/Accounts/$TWILIO_ACCOUNT_SID/Messages.json" \
  -u "$TWILIO_ACCOUNT_SID:$READY_API_KEY" \
  --data-urlencode "To=+12125550199" \
  --data-urlencode "From=+12125550100" \
  --data-urlencode "Body=Your order #1042 has shipped." \
  --data-urlencode "StatusCallback=https://example.com/twilio/status"

const twilio = require('twilio');
const client = twilio(process.env.TWILIO_ACCOUNT_SID, process.env.READY_API_KEY);
client.api.baseUrl = 'https://api.tryready.com';

const msg = await client.messages.create({
  to: '+12125550199',
  from: '+12125550100',
  body: 'Your order #1042 has shipped.',
  statusCallback: 'https://example.com/twilio/status',
});
console.log(msg.sid, msg.status);

The Node example was run against Ready with twilio-node 5.13. Other Twilio libraries work if you can set their API base URL. Otherwise, call the URL directly as the curl example does.

#What’s supported

A text held for quiet hours answers status: "scheduled" with sid: null and a ready_warning saying when it sends.

#Errors

A refusal comes back in Twilio’s error shape, {"code", "message", "more_info", "status"}, plus ready_code, which is Ready’s error code. code is Twilio’s number where one means the same thing. Otherwise it is null, and ready_code says what happened.

If Ready can’t tell whether the carrier took a text, the answer is 202 with ready_code: "send_outcome_unknown". Don’t resend it: check GET .../Messages/{Sid}.json or GET /v1/messages first.

#Status callbacks

Send a StatusCallback with a message, and Ready POSTs Twilio’s form fields there once the message reaches its final status: MessageSid, SmsSid, MessageStatus (delivered or undelivered), SmsStatus, AccountSid, To, From, ApiVersion, and on a failure ErrorCode. Ready doesn’t send the in-between sent status. As with Twilio, a callback that fails isn’t retried. The status stays readable with GET .../Messages/{Sid}.json.

Callbacks are signed with your webhook secret, the one shown when you save a webhook with PUT /v1/webhooks or in Settings → Developers → Webhooks. They carry two headers:

• X-Twilio-Signature, made the way Twilio makes it. Twilio’s own check works if you pass the webhook secret where the Auth Token went: twilio.validateRequest(READY_WEBHOOK_SECRET, signature, url, params).
• X-Signature: sha256=<hex>, the HMAC-SHA256 of the raw form body, as on every Ready webhook (Verifying the signature).

An account that has never saved a webhook has no secret yet, so its callbacks arrive unsigned. Only want status callbacks? Save a webhook once with PUT /v1/webhooks and "enabled": false. That keeps the URL, sends no account events, and the answer carries your secret.

#Replies and opt-outs

Inbound texts don’t use Twilio’s format. Ready posts a JSON event to the webhook URL you saved, for replies, delivery and opt-outs (Webhooks). If each of your Twilio numbers had its own SMS URL, give each Ready number its URL with PUT /v1/numbers/:id: its replies and delivery statuses go there. Ready handles STOP for you and refuses sends to anyone who opted out. To bring your Twilio opt-out list, see Bringing opt-outs from another provider.

#What Ready doesn’t have

• TwiML. A reply in your webhook’s answer is ignored, and inbound texts don’t arrive in Twilio’s request format.
• Messaging Services, SendAt (schedule with POST /sms/schedule instead), more than one MediaUrl, and listing or deleting messages through the Twilio paths. List with GET /v1/messages.
• A status callback for a text held for quiet hours. Read its status with GET /v1/messages once it sends.
• Importing old message history. It stays in Twilio.

Keeping your numbers? Port them under Numbers → Port numbers: Move your numbers to Ready.