Difference between revisions of "Store Auto Text Reply Message Details"

From docs
Jump to: navigation, search
(Created page with "== Store Auto Text Reply Message == === Base URL === https://apimobile.callproof.com === Endpoint === /api/voice/auto-text-reply-message === Purpose === Saves an automatic...")
 
(→‎Successful Response (200))
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
−
== Store Auto Text Reply Message ==
+
== [[Mobile_API]] »Store Auto Text Reply Message ==
  
 
=== Base URL ===
 
=== Base URL ===
Line 39: Line 39:
 
| messages || string || Yes || Auto reply message text (maximum 140 characters)
 
| messages || string || Yes || Auto reply message text (maximum 140 characters)
 
|}
 
|}
 +
 +
=== cURL Example for Android ===
 +
 +
<pre> curl --location 'https://apimobile.callproof.com/api/voice/auto-text-reply-message' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'Content-Type: application/json' \ --data '{ "phone_number": "YOUR_TWILIO_PHONE_NUMBER", "messages": "YOUR_AUTO_REPLY_MESSAGE" }' </pre>
 +
 +
=== cURL Example for iOS ===
 +
 +
<pre> curl --location 'https://apimobile.callproof.com/api/voice/auto-text-reply-message' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'Content-Type: application/json' \ --data '{ "phone_number": "YOUR_TWILIO_PHONE_NUMBER", "messages": "YOUR_AUTO_REPLY_MESSAGE" }' </pre>
  
 
=== Successful Response (200) ===
 
=== Successful Response (200) ===

Latest revision as of 06:35, 21 July 2026

Mobile_API »Store Auto Text Reply Message

Base URL

https://apimobile.callproof.com

Endpoint

/api/voice/auto-text-reply-message

Purpose

Saves an automatic text reply message for a company Twilio phone number. When voicemail is enabled on that number, auto-text is turned on and the reply message is stored.

HTTP Method

POST

Headers

Header Required Description
Authorization Yes Bearer access token

Security

  • Yes – Requires Bearer Token authentication.

Parameters

Path Parameters

None.

Query Parameters

None.

Request Body

Parameter Type Required Description
phone_number string Yes Twilio phone number that will send the auto text reply
messages string Yes Auto reply message text (maximum 140 characters)

cURL Example for Android

 curl --location 'https://apimobile.callproof.com/api/voice/auto-text-reply-message' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'Content-Type: application/json' \ --data '{ "phone_number": "YOUR_TWILIO_PHONE_NUMBER", "messages": "YOUR_AUTO_REPLY_MESSAGE" }'

cURL Example for iOS

 curl --location 'https://apimobile.callproof.com/api/voice/auto-text-reply-message' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \ --header 'Content-Type: application/json' \ --data '{ "phone_number": "YOUR_TWILIO_PHONE_NUMBER", "messages": "YOUR_AUTO_REPLY_MESSAGE" }'

Successful Response (200)

Indicates that the auto text reply message was saved successfully.

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, "The auto text reply message details added successfully.")
uri string Requested resource URI

Error Responses

Status Code Meaning
200 Validation failed – response body uses clientStatusCode 401 with the first validation error message
400 Bad Request – the auto text reply could not be saved
401 Unauthorized – missing, invalid, or expired Bearer token
  • Validation (HTTP 200, clientStatusCode 401) – Missing phone_number or messages, or messages longer than 140 characters.
  • 400 – An error occurred while saving the auto text reply (for example, "Error while adding auto text reply message details").
  • 401 – Authentication failed or the access token is missing/expired.
Retrieved from "http://docs.callproof.com/index.php?title=Store_Auto_Text_Reply_Message_Details&oldid=2735"