Ashley DeBon: /* Successful Response (200) */

2026-07-21T05:25:25Z

‎Successful Response (200)

Ashley DeBon: /* Send SMS */

2026-07-21T05:24:31Z

‎Send SMS

Ashley DeBon: Created page with "== Send SMS == === Base URL === https://apimobile.callproof.com === Endpoint === /api/send-sms === Purpose === Sends an SMS (and optional media) from the authenticated user..."

2026-07-21T05:24:15Z

Created page with "== Send SMS == === Base URL === https://apimobile.callproof.com === Endpoint === /api/send-sms === Purpose === Sends an SMS (and optional media) from the authenticated user..."

New page

== Send SMS ==

=== Base URL ===
https://apimobile.callproof.com

=== Endpoint ===
/api/send-sms

=== Purpose ===
Sends an SMS (and optional media) from the authenticated user’s configured Twilio messaging number to a contact phone number. The message is stored and related activity is recorded for the contact.

=== HTTP Method ===
POST

=== Headers ===
{| class="wikitable"
! Header !! Required !! Description
|-
| Authorization || Yes || Bearer access token
|}

=== Security ===
* '''Yes''' – Requires Bearer Token authentication.

=== Parameters ===

==== Path Parameters ====
None.

==== Query Parameters ====
None.

==== Request Body ====
{| class="wikitable"
! Parameter !! Type !! Required !! Description
|-
| message || string || Yes || SMS text to send (maximum 140 characters)
|-
| contact_phone_number || string || Yes || Destination phone number (exactly 10 digits)
|-
| contact_id || integer/string || Yes || Unique identifier of the contact that owns the phone number
|-
| media_url || string || No || Optional media URL to include with the message (MMS)
|}

=== Successful Response (200) ===
Indicates that the SMS was sent successfully.

{| class="wikitable"
! Field !! Type !! Description
|-
| clientStatusCode || integer || Status indicator for the client (for example, 200)
|-
| user_id || integer || Identifier of the authenticated user
|-
| company_id || integer || Identifier of the authenticated user’s company
|-
| message || string || Confirmation message (for example, "SMS has been sent successfully.")
|-
| uri || string || Requested resource URI
|}

=== Error Responses ===
{| class="wikitable"
! Status Code !! Meaning
|-
| 200 || Validation or business-rule failure – response body uses <code>clientStatusCode</code> 401 (validation) or 400 (business errors such as missing contact/Twilio number)
|-
| 400 || Bad Request – the SMS could not be sent
|-
| 401 || Unauthorized – missing, invalid, or expired Bearer token
|}

* '''Validation (HTTP 200, clientStatusCode 401)''' – Missing/invalid <code>message</code>, <code>contact_phone_number</code>, or <code>contact_id</code> (including message longer than 140 characters, or phone not exactly 10 digits).
* '''400''' – Contact phone not found ("Contact not found"), Twilio messaging number not configured ("Twilio number not found"), Twilio provider error message, or another send failure (for example, "Error while sending message").
* '''401''' – Authentication failed or the access token is missing/expired.

'''Notes'''
* The user must have a valid messaging caller ID (Twilio number) configured.
* The destination number must exist as a contact phone for the given contact and company.

← Older revision		Revision as of 05:24, 21 July 2026
Line 1:		Line 1:
−	== Send SMS ==	+	== [[Mobile_API]] »Send SMS ==

	=== Base URL ===		=== Base URL ===

@@ Line 43: / Line 43: @@
 | media_url || string || No || Optional media URL to include with the message (MMS)
 |}
 === Successful Response (200) ===

Twilio Outgoing Message - Revision history

Ashley DeBon: /* Successful Response (200) */

Ashley DeBon: /* Send SMS */

Ashley DeBon: Created page with "== Send SMS == === Base URL === https://apimobile.callproof.com === Endpoint === /api/send-sms === Purpose === Sends an SMS (and optional media) from the authenticated user..."