Difference between revisions of "Recorded Voicemail Message Details"
Ashley DeBon (talk | contribs) (→Get Auto Text Reply Message) |
Ashley DeBon (talk | contribs) (→Successful Response (200)) |
||
| Line 37: | Line 37: | ||
==== Request Body ==== | ==== Request Body ==== | ||
None. | None. | ||
| + | |||
| + | === cURL Example for Android === | ||
| + | |||
| + | <pre> curl --location 'https://apimobile.callproof.com/api/voice/auto-text-reply-message/YOUR_PHONE_NUMBER' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' </pre> | ||
| + | |||
| + | === cURL Example for iOS === | ||
| + | |||
| + | <pre> curl --location 'https://apimobile.callproof.com/api/voice/auto-text-reply-message/YOUR_PHONE_NUMBER' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' </pre> | ||
=== Successful Response (200) === | === Successful Response (200) === | ||
Latest revision as of 06:43, 21 July 2026
Mobile_API »Get Auto Text Reply Message
Base URL
https://apimobile.callproof.com
Endpoint
/api/voice/auto-text-reply-message/{phone_number}
Purpose
Retrieves the auto text reply configuration for a company Twilio phone number, including whether auto-text is enabled and the reply message text.
HTTP Method
GET
Headers
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | Bearer access token |
Security
- Yes – Requires Bearer Token authentication.
Parameters
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| phone_number | string | Yes | Twilio phone number whose auto text reply settings should be retrieved |
Query Parameters
None.
Request Body
None.
cURL Example for Android
curl --location 'https://apimobile.callproof.com/api/voice/auto-text-reply-message/YOUR_PHONE_NUMBER' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
cURL Example for iOS
curl --location 'https://apimobile.callproof.com/api/voice/auto-text-reply-message/YOUR_PHONE_NUMBER' \ --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'
Successful Response (200)
Returns the auto text reply settings for the phone number. If no matching number is found, data is an empty array.
| 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 |
| data | array | Auto text reply details (see below), or empty when not found |
| uri | string | Requested resource URI |
data[]
| Field | Type | Description |
|---|---|---|
| id | integer | Unique identifier of the Twilio phone number record |
| is_autotext | boolean | Whether auto text reply is enabled for this number |
| message | string | Auto text reply message content |
Error Responses
| Status Code | Meaning |
|---|---|
| 400 | Bad Request – auto text reply details could not be retrieved |
| 401 | Unauthorized – missing, invalid, or expired Bearer token |
- 400 – An error occurred while retrieving auto text reply details (for example, "Error while retrieving the auto text reply message details").
- 401 – Authentication failed or the access token is missing/expired.
