Get Call Permission Status

GET https://chatapps.8x8.com/api/v1/whatsapp/subaccounts/:subAccountId/channels/:channelId/callPermissions

This endpoint is used to check the status of call permission for a specific destination on WhatsApp. It returns whether the business is allowed to initiate voice calls to the specified phone number.

Request

Path Parameters

    subAccountId stringrequired

    Sub-account identifier

    channelId stringrequired

    Channel identifier

Query Parameters

    destination stringrequired

    Destination phone number to check call permission status (E.164 format)

    Example: +6500000000

Success response

Schema

    statusstring

    The current call permission status

    Possible values: [temporary, permanent, not_granted]

    Example: temporary

    actions object[]

    List of actions and their permissions

  • Array [
  • actionNamestring

    Name of the action

    Possible values: [send_call_permission_request, start_call]

    Example: send_call_permission_request
    canPerformActionboolean

    Whether the action can be performed

    Example: true

    limits object[]

    Rate limits for this action

  • Array [
  • timePeriodstring

    ISO 8601 duration format (e.g., PT24H for 24 hours, P7D for 7 days)

    Example: PT24H
    maxAllowedinteger

    Maximum number of actions allowed in the time period

    Example: 1
    currentUsageinteger

    Current usage count in the time period

    Example: 0
  • ]
  • ]
  • expirationTimestring<date-time>

    ISO 8601 timestamp indicating when the call permission expires

    Example: 2026-02-06T08:12:30.00Z
{
"status":"temporary",
"actions":[
{
"actionName":"send_call_permission_request",
"canPerformAction":true,
"limits":[
{
"timePeriod":"PT24H",
"maxAllowed":1,
"currentUsage":0
}
]
}
],
"expirationTime":"2026-02-06T08:12:30.00Z"
}
{
"status":"temporary",
"actions":[
{
"actionName":"send_call_permission_request",
"canPerformAction":true,
"limits":[
{
"timePeriod":"PT24H",
"maxAllowed":1,
"currentUsage":0
},
{
"timePeriod":"P7D",
"maxAllowed":2,
"currentUsage":0
}
]
},
{
"actionName":"start_call",
"canPerformAction":true,
"limits":[
{
"timePeriod":"PT24H",
"maxAllowed":100,
"currentUsage":0
}
]
}
],
"expirationTime":"2026-02-06T08:12:30.00Z"
}

Bad request error response

Schema

    codeintegerrequired

    Error code

    messagestring

    Error description

    errorIdstring<uuid>required

    Unique id of error. You can use it as reference when sending enquiries to 8x8 support

    timestampstring<date-time>required

    Data and time of the error occurence

{
"code":1001,
"message":"Provided subAccountId doesn't belongs to your account",
"errorId":"91b106f0-c0da-4aba-a43a-7af9c5893a80",
"timestamp":"2017-04-19T02:31:19.4297387+00:00"
}
{
"code":1002,
"message":"Invalid MSISDN format (not E.164 international number)",
"errorId":"b4478860-b76c-e811-814e-022a35cc1c71",
"timestamp":"2018-08-04T09:25:40.9235752+00:00"
}

Request was not authenticated response

Schema

    codeintegerrequired

    Error code

    messagestring

    Error description

    errorIdstring<uuid>required

    Unique id of error. You can use it as reference when sending enquiries to 8x8 support

    timestampstring<date-time>required

    Data and time of the error occurence

{
"code":1001,
"message":"Provided subAccountId doesn't belongs to your account",
"errorId":"91b106f0-c0da-4aba-a43a-7af9c5893a80",
"timestamp":"2017-04-19T02:31:19.4297387+00:00"
}
{
"code":1200,
"message":"Request was not authenticated properly",
"errorId":"db9dced4-3534-4d86-9d18-6b448af0d621",
"timestamp":"2018-08-02T09:42:38.8988997+00:00"
}

Internal server error

Schema

    codeintegerrequired

    Error code

    messagestring

    Error description

    errorIdstring<uuid>required

    Unique id of error. You can use it as reference when sending enquiries to 8x8 support

    timestampstring<date-time>required

    Data and time of the error occurence

{
"code":1001,
"message":"Provided subAccountId doesn't belongs to your account",
"errorId":"91b106f0-c0da-4aba-a43a-7af9c5893a80",
"timestamp":"2017-04-19T02:31:19.4297387+00:00"
}
{
"code":2000,
"message":"Internal server error",
"errorId":"db9dced4-3534-4d86-9d18-6b448af0d621",
"timestamp":"2018-07-02T09:42:38.8988997+00:00"
}

Source: https://developer.8x8.com/connect/reference/get-call-permission-status · 8x8 CPaaS Developer Docs. Synced for support deflection.

Was this article helpful?
or
0 out of 0 found this helpful

0 Comments

Please sign in to leave a comment.

Didn't find what you were looking for?

Submit a request