Send an individual SMS message.
Request body (JSON) example:
{
"supporter_id": 123,
"message": "Hello from Quorum!"
}
Sample query: www.quorum.us/api/sendsms/send_individual_sms/
Message queued successfully
improperly configured request
authorization failure
internal server error
{- "from": "+15551234567",
- "id": 123,
- "num_segments": 1,
- "success": true,
- "to": "+15559876543"
}| archived | boolean |
| associated_number | string NOTE: Parameter accepts additional qualifiers appended to the end: |
| bulk_sms_id | integer <int64> The bulksms with which this sendsms is associated. NOTE: Parameter accepts additional qualifiers appended to the end: |
| converted | boolean |
| current_status | integer <int64> NOTE: Parameter accepts additional qualifiers appended to the end: See the Enumeration Documentation CSV file located at Quorum_API_Enumeration_Values.csv, name TextDeliveryStatus, for an explanation of values. |
| opens | integer <int64> NOTE: Parameter accepts additional qualifiers appended to the end: |
| dehydrate | Array of strings Option to provide additional detail for certain fields, either by expanding those fields with additional details from the related model or by substituting more informative values for the actual database values. |
| advanced_search | string Perform an advanced text search on the datset with the provided text. This search will use the most comprehensive search method available on the requested endpoint, but can take slightly longer to return results. |
| limit | integer <int64> Default: 20 The number of records to return (for pagination). |
| offset | integer <int64> Default: 0 The number of records to offset the start of the data being returned (for pagination). |
SendSMS retrieved successfully
improperly configured request
authorization failure
internal server error
{- "_extra": { },
- "archived": false,
- "associated_number": "string",
- "bulk_sms": "/api/bulksms/1/",
- "bulk_sms_description": "string",
- "bulk_sms_send_time": "2019-08-24T14:15:22Z",
- "converted": false,
- "created": "2019-08-24T14:15:22Z",
- "current_status": 1,
- "delivered_event": { },
- "effective_message_count": 0,
- "failed_event": { },
- "id": 0,
- "message_content": "string",
- "message_direction": 2,
- "message_uuid": "string",
- "opens": 0,
- "queued_event": { },
- "rcpt_dict": { },
- "rejected_event": { },
- "resource_uri": "string",
- "send_time": "2019-08-24T14:15:22Z",
- "sent_event": { },
- "supporter_email": "string",
- "supporter_id": "/api/newsupporter/1/",
- "supporter_name": "string",
- "supporter_public_organization": "string",
- "supporter_title": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "undelivered_event": { },
- "updated": "2019-08-24T14:15:22Z"
}SendSMS retrieved successfully
improperly configured request
authorization failure
internal server error
{- "_extra": { },
- "archived": false,
- "associated_number": "string",
- "bulk_sms": "/api/bulksms/1/",
- "bulk_sms_description": "string",
- "bulk_sms_send_time": "2019-08-24T14:15:22Z",
- "converted": false,
- "created": "2019-08-24T14:15:22Z",
- "current_status": 1,
- "delivered_event": { },
- "effective_message_count": 0,
- "failed_event": { },
- "id": 0,
- "message_content": "string",
- "message_direction": 2,
- "message_uuid": "string",
- "opens": 0,
- "queued_event": { },
- "rcpt_dict": { },
- "rejected_event": { },
- "resource_uri": "string",
- "send_time": "2019-08-24T14:15:22Z",
- "sent_event": { },
- "supporter_email": "string",
- "supporter_id": "/api/newsupporter/1/",
- "supporter_name": "string",
- "supporter_public_organization": "string",
- "supporter_title": "string",
- "timestamp": "2019-08-24T14:15:22Z",
- "undelivered_event": { },
- "updated": "2019-08-24T14:15:22Z"
}