API Documentation

1. Sending SMS or RCS Messages

To send an SMS or RCS message via QuickSMS, your request must include the key routing and content fields:

API Endpoint:

https://api.quicksms.com/rcs/v2/api

Include your Basic Auth credentials with the request header.

POST https://api.quicksms.com/rcs/v2/api
Content-Type: application/json
Authorization: Basic <base64-encoded-username:password>

{
  "reqType": "BULK",
  "MSISDN": "447891658396",
  "msg": "test message",
  "sender": "TestSender"
}

Optional Parameters

Successful Response

{
  "reference": "42"
}

Failed Response Example

{
  "Error": 206,
  "Description": "Invalid username or password"
}

2. RCS/SMS Delivery Receipts

QuickSMS can send delivery receipts to your server via POST. Format:

{
  "reference": "42",
  "MSISDN": "447123456789",
  "status": "3",
  "substatus": "5",
  "deliverytime": "2024-01-01 16:36:48",
  "cid": "customid"
}

Respond with: RECEIVED in under 1 second to acknowledge.

Status Codes

• 3 – Delivered
• 2 – Undeliverable
• 4 – Expired
• 5 – Rejected

Substatus Codes

• 5 – Delivered to handset
• 9 – Invalid/unreachable destination
• 10 – Do Not Disturb
• 14 – Blocklisted

3. RCS Seen Receipts

Seen receipts are sent via POST when a user views an RCS message:

{
  "reference": "42",
  "MSISDN": "447123456789",
  "seentime": "2024-01-01 16:36:48",
  "cid": "customid"
}

Reply: RECEIVED within 1 second.

4. Receiving Incoming Messages

When messages are received, QuickSMS will POST to your configured endpoint:

{
  "MSISDN": "447123456789",
  "Message": "Hello",
  "Number": "44789011829",
  "DateReceived": "2024-01-28 11:54:32",
  "ID": "MxJFwONIywR7yZysg7iAtDXQ"
}

Respond with: RECEIVED to acknowledge.