AXaxilioai
phones

Release a phone

Changed on

Deallocates a phone the caller's org currently holds. The session is billed and the phone is torn down asynchronously. Pass session_id to end that session only: if the phone has already moved on to another session, nothing is released and the call still succeeds.

post/phones/{phone_id}:deallocate

Request

Path parameters

phone_idstring required

phone identifier to deallocate

Request body

$schemastring uri

A URL to the JSON Schema for this object.

session_idstring

End this session only. If the phone has already moved on to another session, nothing is released and the call still succeeds. Omit to end whatever session the phone holds.

Example request

{
  "$schema": "/api/v1/PhoneDeallocateRequest.json"
}

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

agent_idstring

The agent whose run the released session ran; absent for an interactive session.

deallocated_atstring date-time

Timestamp when the device was released.

phone_idstring required

Released device's identifier.

session_idstring required

Session that was closed.

Example response

{
  "$schema": "/api/v1/PhoneDeallocateResponse.json"
}

Changes

  • 80de09d0e643Revision changes
    • breaking

      removed the required property from the response with the status

    • info

      added the optional property to the response with the status

  • 49b1da5a7974Revision changes
    • info

      added optional request body

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status