Twilio Access Token - Revision history

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

2026-07-21T07:25:09Z

‎Successful Response (200)

Ashley DeBon: /* Generate Twilio Access Token */

2026-07-21T07:24:29Z

‎Generate Twilio Access Token

Ashley DeBon: Created page with "== Generate Twilio Access Token == === Base URL === https://apimobile.callproof.com === Endpoint === /api/generate-access-Token === Purpose === Generates a Twilio Voice acc..."

2026-07-21T07:24:12Z

Created page with "== Generate Twilio Access Token == === Base URL === https://apimobile.callproof.com === Endpoint === /api/generate-access-Token === Purpose === Generates a Twilio Voice acc..."

New page

== Generate Twilio Access Token ==

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

=== Endpoint ===
/api/generate-access-Token

=== Purpose ===
Generates a Twilio Voice access token for the authenticated user so the mobile app can make and receive calls. Also returns the user’s caller ID information when available.

=== 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
|-
| device_type || string || Yes || Device platform used to select push credentials. Use <code>android</code> for Android; other values (for example, <code>ios</code>) use iOS push credentials
|}

=== Successful Response (200) ===
Returns the Twilio Voice JWT and caller ID details.

{| 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
|-
| data || object || Token and caller ID payload (see below)
|-
| message || string || Present in some responses when caller ID is missing (for example, "Caller ID not found")
|-
| uri || string || Requested resource URI
|}

==== data ====
{| class="wikitable"
! Field !! Type !! Description
|-
| token || string || Twilio Voice JWT access token used by the client SDK
|-
| caller_id || string || Outbound caller ID phone number (with country code when available); empty string when not found
|-
| message_caller_id || boolean/string || Messaging caller ID value when configured; otherwise <code>false</code>
|}

=== Error Responses ===
{| class="wikitable"
! Status Code !! Meaning
|-
| 400 || Bad Request – the access token could not be generated
|-
| 401 || Unauthorized – missing, invalid, or expired Bearer token
|}

* '''400''' – Token generation failed (for example, "Error while generating token").
* '''401''' – Authentication failed or the access token is missing/expired.

← Older revision		Revision as of 07:24, 21 July 2026
Line 1:		Line 1:
−	== Generate Twilio Access Token ==	+	== [[Mobile_API]] »Generate Twilio Access Token ==

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

@@ Line 37: / Line 37: @@
 | device_type || string || Yes || Device platform used to select push credentials. Use <code>android</code> for Android; other values (for example, <code>ios</code>) use iOS push credentials
 |}
 === Successful Response (200) ===