Get a list of Extensions. Create a new Extension. Patch an existing Extension resource. Get a single Extension resource.

Transcription

1 Last modified on Extension The Extension resources is a collection of Endpoints and Route Points that represent a User's Extension. The Extension Resource allows a User's registered devices to ring when an Extension is dialed. API Endpoint /api/v4/pbx/extension/ Methods NAME DESCRIPTION GET /api/v4/pbx/extension/ Get a list of Extensions. POST /api/v4/pbx/extension/ Create a new Extension. PATCH /api/v4/pbx/extension/ Patch an existing Extension resource. GET /api/v4/pbx/extension/{id}/ Get a single Extension resource. PUT /api/v4/pbx/extension/{id}/ Update an existing Extension. DELETE /api/v4/pbx/extension/{id}/ Delete an Extension. PATCH /api/v4/pbx/extension/{id}/ Patch a single Extension resource. Methods GET /api/v4/pbx/extension/

2 Get a list of Extensions. RETURNS 200 Successfully retrieved resource(s) EXAMPLE RESPONSE { "data": [ { "auto_record": false, "available_profiles": "/api/v4/pbx/available_profile_map/97/", "channel_data": null, "created": " T21:16:57Z", "current_profile": "/api/v4/pbx/handling_profile/231/", "default_area_code": null, "description": null, "display_name": null, "ek": "100", "emergency_ani": null, "endpoints": [], "extension_id": 41, "external_caller_id_": null, "internal_caller_id_name": null, "internal_caller_id_": "100", "intl_calling": false, "is_extension_subtenant": true, "mailbox": { "available_greeting_map": "/api/v4/pbx/available_greeting_map/46/", "created": " T21:16:57Z", "default_greeting": "/api/v4/pbx/voice_recording/53/", "delete_vm": false, "deleted_messages": "/api/v4/pbx/folder/131/", "ek": "100", " _address": null, " _attachment": false, "enabled": true, "mailbox_id": 42, "modified": " T21:16:57Z", "new_messages": "/api/v4/pbx/folder/132/", "pin": "1234", "play_cid": true, "play_envelope": true, "resource_uri": "/api/v4/pbx/mailbox/42/", "saved_messages": "/api/v4/pbx/folder/133/", "temp_greeting_enabled": false }, "modified": " T21:16:57Z", "": "100", "resource_uri": "/api/v4/pbx/extension/41/", "routepoints": [ "/api/v4/pbx/routepoint/177/"

3 } ], "timezone": "", "user": "/api/v4/access/user/19/" } ], "meta": { "limit": 20, "next": null, "offset": 0, "previous": null, "total_count": 11 } data array Collection of objects returned by the API. DATA FIELDS auto_record Flag indicating whether all calls on the Extension are automatically recorded. available_profiles The AvailableProfileMap associated with the Extension. channel_data JSON Reserved for future use. created Date/time the resource was created. current_profile The Handling Profile currently being used for the Extension. default_area_code The default area code associated with the external_caller_id_. description The description of the Extension. display_name None The display name for the Extension. ek UUID A unique ID used by the Corvisa platform. emergency_ani The caller ID to send with emergency calls.

4 endpoints array List of Endpoints associated with the Extension. By default, these will all be rung when the User's Extension is dialed. extension_id Unique ID for the Extension. external_caller_id_ The as it appears on the caller ID for the party receiving a call. internal_caller_id_name The name as it appears on the caller ID. internal_caller_id_ The as it appears on the caller ID for internal use. intl_calling Flag indicating whether international calls can be made from the Extension. is_extension_subtenant Flag indicating whether the currently authenticated User's active SubTenant matches the SubTenant associated with this Extension. mailbox JSON Complete representation of the extension's Mailbox. MAILBOX FIELDS available_greeting_map The Available Greeting Map that contains the greetings to play before a message is left. created Date/time Mailbox was created. default_greeting The Voice Recording to use as the default greeting. delete_vm Flag indicating whether voic Messages are deleted automatically after being played. deleted_messages The Mailbox Folder to store deleted voic Messages. ek UUID A unique ID used by the Corvisa platform. _address The address associated with the Mailbox. _attachment Flag indicating whether voic messages are sent as attachments to the associated address.

5 enabled Flag indicating whether the Mailbox is active. mailbox_id Unique ID of the Mailbox associated with the Extension. modified Date/time Mailbox was last modified. new_messages The Mailbox Folder to store new voic Messages. pin Security PIN used to open/unlock the Mailbox. play_cid Flag indicating whether Caller ID information is read before a voic message is played. play_envelope Flag indicating whether the created date and time is read before a voic message is played. resource_uri for the Mailbox resource. saved_messages The Mailbox Folder to store saved voic Messages. temp_greeting_enabled Flag indicating whether a temporary recorded greeting is used in place of the default greeting. modified Date/time the Extension was last modified. The Route Point. resource_uri of the resource. routepoints array List of all Route Points associated with the Extension. timezone Time zone for the Extension. user The User associated with the Extension.

6 meta object Information about the response. META FIELDS limit Maximum of objects per page in the response. next used to access the next page of the response. offset Number of objects skipped for this response. previous used to access the previous page of the response. total_count Total of objects accessible through this endpoint. POST /api/v4/pbx/extension/ Create a new Extension. EXAMPLE REQUEST { } "": "555", "user": "/api/v4/access/user/283/" FIELDS REQUIRED The Route Point. This value must be unique. Use one of the available GET requests to return an available Route Point. Request: GET /api/v4/pbx/routepoint/available/ Request: GET /api/v4/pbx/routepoint/available/? startswith={} user REQUIRED The User associated with the Extension. Use the User GET request to return a list of available Users.

7 Request: GET /api/v4/access/user/ RETURNS 201 Successfully created a new resource EXAMPLE RESPONSE { "auto_record": false, "available_profiles": "/api/v4/pbx/available_profile_map/221/", "channel_data": null, "created": " T21:16:57Z", "current_profile": "/api/v4/pbx/handling_profile/108/", "default_area_code": null, "description": null, "display_name": null, "ek": "555", "emergency_ani": null, "endpoints": [], "extension_id": 43, "external_caller_id_": null, "internal_caller_id_name": null, "internal_caller_id_": "555", "intl_calling": false, "is_extension_subtenant": true, "mailbox": { "available_greeting_map": "/api/v4/pbx/available_greeting_map/253/", "created": " T21:16:57Z", "default_greeting": "/api/v4/pbx/voice_recording/69/", "delete_vm": false, "deleted_messages": "/api/v4/pbx/folder/208/", "ek": "555", " _address": null, " _attachment": false, "enabled": true, "mailbox_id": 48, "modified": " T21:16:57Z", "new_messages": "/api/v4/pbx/folder/236/", "pin": "1234", "play_cid": true, "play_envelope": true, "resource_uri": "/api/v4/pbx/mailbox/48/", "saved_messages": "/api/v4/pbx/folder/197/", "temp_greeting_enabled": false }, "modified": " T21:16:57Z", "": "555",

8 } "resource_uri": "/api/v4/pbx/extension/43/", "routepoints": [ "/api/v4/pbx/routepoint/26/" ], "timezone": "", "user": "/api/v4/access/user/283/" auto_record Flag indicating whether all calls on the Extension are automatically recorded. available_profiles The AvailableProfileMap associated with the Extension. channel_data JSON Reserved for future use. created Date/time the resource was created. current_profile The Handling Profile currently being used for the Extension. default_area_code The default area code associated with the external_caller_id_. description The description of the Extension. display_name None The display name for the Extension. ek UUID A unique ID used by the Corvisa platform. emergency_ani The caller ID to send with emergency calls. endpoints array List of Endpoints associated with the Extension. By default, these will all be rung when the User's Extension is dialed. extension_id Unique ID for the Extension. external_caller_id_ The as it appears on the caller ID for the party receiving a call. internal_caller_id_name The name as it appears on the caller ID.

9 internal_caller_id_ The as it appears on the caller ID for internal use. intl_calling Flag indicating whether international calls can be made from the Extension. is_extension_subtenant Flag indicating whether the currently authenticated User's active SubTenant matches the SubTenant associated with this Extension. mailbox JSON Complete representation of the extension's Mailbox. MAILBOX FIELDS available_greeting_map The Available Greeting Map that contains the greetings to play before a message is left. created Date/time Mailbox was created. default_greeting The Voice Recording to use as the default greeting. delete_vm Flag indicating whether voic Messages are deleted automatically after being played. deleted_messages The Mailbox Folder to store deleted voic Messages. ek UUID A unique ID used by the Corvisa platform. _address The address associated with the Mailbox. _attachment Flag indicating whether voic messages are sent as attachments to the associated address. enabled Flag indicating whether the Mailbox is active. mailbox_id Unique ID of the Mailbox associated with the Extension. modified Date/time Mailbox was last modified. new_messages The Mailbox Folder to store new voic Messages.

10 pin Security PIN used to open/unlock the Mailbox. play_cid Flag indicating whether Caller ID information is read before a voic message is played. play_envelope Flag indicating whether the created date and time is read before a voic message is played. resource_uri for the Mailbox resource. saved_messages The Mailbox Folder to store saved voic Messages. temp_greeting_enabled Flag indicating whether a temporary recorded greeting is used in place of the default greeting. modified Date/time the Extension was last modified. The Route Point. resource_uri of the resource. routepoints array List of all Route Points associated with the Extension. timezone Time zone for the Extension. user The User associated with the Extension. PATCH /api/v4/pbx/extension/ Patch an existing Extension resource. EXAMPLE REQUEST { "data": [ {

11 } ] } "description": "extension 100 has a description now", "resource_uri": "/api/v4/pbx/extension/44/", "user": "/api/v4/access/user/286/" FIELDS data REQUIRED Collection of objects returned by the API. array DATA FIELDS resource_uri REQUIRED The of the Extension resource you are patching. description The description of the Extension. user The User associated with the Extension. Use the User GET request to return a list of available Users. Request: GET /api/v4/access/user/ RETURNS 202 Successfully patched the resource EXAMPLE RESPONSE { "objects": [ { "auto_record": false, "available_profiles": "/api/v4/pbx/available_profile_map/31/", "channel_data": null, "created": " T21:16:57Z", "current_profile": "/api/v4/pbx/handling_profile/220/", "default_area_code": null, "description": "extension 100 has a description now", "display_name": null, "ek": "100",

12 } ] } "emergency_ani": null, "endpoints": [], "extension_id": 44, "external_caller_id_": null, "internal_caller_id_name": null, "internal_caller_id_": "100", "intl_calling": false, "is_extension_subtenant": true, "mailbox": { "available_greeting_map": "/api/v4/pbx/available_greeting_map/51/", "created": " T21:16:57Z", "default_greeting": "/api/v4/pbx/voice_recording/58/", "delete_vm": false, "deleted_messages": "/api/v4/pbx/folder/152/", "ek": "100", " _address": null, " _attachment": false, "enabled": true, "mailbox_id": 47, "modified": " T21:16:57Z", "new_messages": "/api/v4/pbx/folder/153/", "pin": "1234", "play_cid": true, "play_envelope": true, "resource_uri": "/api/v4/pbx/mailbox/47/", "saved_messages": "/api/v4/pbx/folder/154/", "temp_greeting_enabled": false }, "modified": " T21:16:57Z", "": "100", "resource_uri": "/api/v4/pbx/extension/44/", "routepoints": [ "/api/v4/pbx/routepoint/233/" ], "timezone": "", "user": "/api/v4/access/user/286/" objects OBJECTS FIELDS auto_record Flag indicating whether all calls on the Extension are automatically recorded. available_profiles The AvailableProfileMap associated with the Extension.

13 channel_data JSON Reserved for future use. created Date/time the resource was created. current_profile The Handling Profile currently being used for the Extension. default_area_code The default area code associated with the external_caller_id_. description The description of the Extension. display_name None The display name for the Extension. ek UUID A unique ID used by the Corvisa platform. emergency_ani The caller ID to send with emergency calls. endpoints array List of Endpoints associated with the Extension. By default, these will all be rung when the User's Extension is dialed. extension_id Unique ID for the Extension. external_caller_id_ The as it appears on the caller ID for the party receiving a call. internal_caller_id_name The name as it appears on the caller ID. internal_caller_id_ The as it appears on the caller ID for internal use. intl_calling Flag indicating whether international calls can be made from the Extension. is_extension_subtenant Flag indicating whether the currently authenticated User's active SubTenant matches the SubTenant associated with this Extension. mailbox JSON Complete representation of the extension's Mailbox. MAILBOX FIELDS

14 available_greeting_map The Available Greeting Map that contains the greetings to play before a message is left. created Date/time Mailbox was created. default_greeting The Voice Recording to use as the default greeting. delete_vm Flag indicating whether voic Messages are deleted automatically after being played. deleted_messages The Mailbox Folder to store deleted voic Messages. ek UUID A unique ID used by the Corvisa platform. _address The address associated with the Mailbox. _attachment Flag indicating whether voic messages are sent as attachments to the associated address. enabled Flag indicating whether the Mailbox is active. mailbox_id Unique ID of the Mailbox associated with the Extension. modified Date/time Mailbox was last modified. new_messages The Mailbox Folder to store new voic Messages. pin Security PIN used to open/unlock the Mailbox. play_cid Flag indicating whether Caller ID information is read before a voic message is played. play_envelope Flag indicating whether the created date and time is read before a voic message is played. resource_uri for the Mailbox resource. saved_messages The Mailbox Folder to store saved voic Messages.

15 temp_greeting_enabled Flag indicating whether a temporary recorded greeting is used in place of the default greeting. modified Date/time the Extension was last modified. The Route Point. resource_uri of the resource. routepoints array List of all Route Points associated with the Extension. timezone Time zone for the Extension. user The User associated with the Extension. GET /api/v4/pbx/extension/{id}/ Get a single Extension resource. RETURNS 200 Successfully retrieved resource EXAMPLE RESPONSE { "auto_record": false, "available_profiles": "/api/v4/pbx/available_profile_map/205/", "channel_data": null, "created": " T21:16:57Z", "current_profile": "/api/v4/pbx/handling_profile/37/", "default_area_code": null, "description": null, "display_name": null, "ek": "100", "emergency_ani": null, "endpoints": [], "extension_id": 45, "external_caller_id_": null, "internal_caller_id_name": null,

16 } "internal_caller_id_": "100", "intl_calling": false, "is_extension_subtenant": true, "mailbox": { "available_greeting_map": "/api/v4/pbx/available_greeting_map/53/", "created": " T21:16:57Z", "default_greeting": "/api/v4/pbx/voice_recording/60/", "delete_vm": false, "deleted_messages": "/api/v4/pbx/folder/161/", "ek": "100", " _address": null, " _attachment": false, "enabled": true, "mailbox_id": 49, "modified": " T21:16:57Z", "new_messages": "/api/v4/pbx/folder/162/", "pin": "1234", "play_cid": true, "play_envelope": true, "resource_uri": "/api/v4/pbx/mailbox/49/", "saved_messages": "/api/v4/pbx/folder/163/", "temp_greeting_enabled": false }, "modified": " T21:16:57Z", "": "100", "resource_uri": "/api/v4/pbx/extension/45/", "routepoints": [ "/api/v4/pbx/routepoint/96/" ], "timezone": "", "user": "/api/v4/access/user/138/" auto_record Flag indicating whether all calls on the Extension are automatically recorded. available_profiles The AvailableProfileMap associated with the Extension. channel_data JSON Reserved for future use. created Date/time the resource was created. current_profile The Handling Profile currently being used for the Extension. default_area_code The default area code associated with the external_caller_id_.

17 description The description of the Extension. display_name None The display name for the Extension. ek UUID A unique ID used by the Corvisa platform. emergency_ani The caller ID to send with emergency calls. endpoints array List of Endpoints associated with the Extension. By default, these will all be rung when the User's Extension is dialed. extension_id Unique ID for the Extension. external_caller_id_ The as it appears on the caller ID for the party receiving a call. internal_caller_id_name The name as it appears on the caller ID. internal_caller_id_ The as it appears on the caller ID for internal use. intl_calling Flag indicating whether international calls can be made from the Extension. is_extension_subtenant Flag indicating whether the currently authenticated User's active SubTenant matches the SubTenant associated with this Extension. mailbox JSON Complete representation of the extension's Mailbox. MAILBOX FIELDS available_greeting_map The Available Greeting Map that contains the greetings to play before a message is left. created Date/time Mailbox was created. default_greeting The Voice Recording to use as the default greeting. delete_vm Flag indicating whether voic Messages are deleted automatically after being played.

18 deleted_messages The Mailbox Folder to store deleted voic Messages. ek UUID A unique ID used by the Corvisa platform. _address The address associated with the Mailbox. _attachment Flag indicating whether voic messages are sent as attachments to the associated address. enabled Flag indicating whether the Mailbox is active. mailbox_id Unique ID of the Mailbox associated with the Extension. modified Date/time Mailbox was last modified. new_messages The Mailbox Folder to store new voic Messages. pin Security PIN used to open/unlock the Mailbox. play_cid Flag indicating whether Caller ID information is read before a voic message is played. play_envelope Flag indicating whether the created date and time is read before a voic message is played. resource_uri for the Mailbox resource. saved_messages The Mailbox Folder to store saved voic Messages. temp_greeting_enabled Flag indicating whether a temporary recorded greeting is used in place of the default greeting. modified Date/time the Extension was last modified. The Route Point.

19 resource_uri of the resource. routepoints array List of all Route Points associated with the Extension. timezone Time zone for the Extension. user The User associated with the Extension. PUT /api/v4/pbx/extension/{id}/ Update an existing Extension. EXAMPLE REQUEST { "auto_record": true, "available_profiles": "/api/v4/pbx/available_profile_map/54/", "channel_data": null, "current_profile": "/api/v4/pbx/handling_profile/189/", "default_area_code": null, "display_name": "PUT Extension", "ek": "100", "emergency_ani": null, "endpoints": [], "extension_id": 46, "external_caller_id_": null, "internal_caller_id_name": null, "internal_caller_id_": "100", "intl_calling": false, "is_extension_subtenant": false, "mailbox": { "available_greeting_map": "/api/v4/pbx/available_greeting_map/55/", "default_greeting": "/api/v4/pbx/voice_recording/62/", "delete_vm": false, "deleted_messages": "/api/v4/pbx/folder/170/", "ek": "100", " _address": null, " _attachment": false, "enabled": true, "mailbox_id": 51, "new_messages": "/api/v4/pbx/folder/171/", "pin": "5678", "play_cid": true, "play_envelope": true, "resource_uri": "/api/v4/pbx/mailbox/51/", "saved_messages": "/api/v4/pbx/folder/172/",

20 } "temp_greeting_enabled": false }, "": "100", "resource_uri": "/api/v4/pbx/extension/46/", "timezone": "", "user": "/api/v4/access/user/289/" FIELDS auto_record Flag indicating whether all calls on the Extension are automatically recorded. available_profiles The AvailableProfileMap to associate with the Extension. Use the Available Profile Map GET request to return a list of Available Profile Maps. Request: GET /api/v4/pbx/available_profile_map/ channel_data Reserved for future use. JSON current_profile The Handling Profile currently being used for the Extension. Use the Handling Profile GET request to return a list of available Handling Profiles. Request: GET /api/v4/pbx/handling_profile/ default_area_code The default area code associated with the external_caller_id_. display_name The display name for the Extension. None ek A unique ID used by the Corvisa platform. UUID emergency_ani The caller ID to send with emergency calls.

21 endpoints array List of Endpoints associated with the Extension. By default, these will all be rung when the User's Extension is dialed. Use the Endpoint GET request to return a list of available Endpoints. Request: GET /api/v4/pbx/endpoint/ extension_id Unique ID for the Extension. external_caller_id_ The as it appears on the caller ID for the party receiving a call. internal_caller_id_name The name as it appears on the caller ID. internal_caller_id_ The as it appears on the caller ID for internal use. intl_calling Flag indicating whether international calls can be made from the Extension. is_extension_subtenant Flag indicating whether the currently authenticated User's active SubTenant matches the SubTenant associated with this Extension. mailbox Complete representation of the extension's Mailbox. JSON MAILBOX FIELDS available_greeting_map The Available Greeting Map that contains the greetings to play before a message is left. default_greeting The Voice Recording to use as the default greeting. Use the Voice Recording GET request to return a list of available Voice Recordings. Request: GET /api/v4/pbx/voice_recording/

22 delete_vm Flag indicating whether voic Messages are deleted automatically after being played. deleted_messages The Mailbox Folder to store deleted voic Messages. This field is read-only. ek A unique ID used by the Corvisa platform. UUID _address The address associated with the Mailbox. _attachment Flag indicating whether voic messages are sent as attachments to the associated address. enabled Flag indicating whether the Mailbox is active. mailbox_id Unique ID of the Mailbox associated with the Extension. Use the Mailbox GET request to return a list of available Mailboxes Request: GET /api/v4/pbx/mailbox/ new_messages The Mailbox Folder to store new voic Messages. This field is readonly. pin Security PIN used to open/unlock the Mailbox. play_cid Flag indicating whether Caller ID information is read before a voic message is played. play_envelope Flag indicating whether the created date and time is read before a voic message is played. resource_uri for the Mailbox resource.

23 saved_messages The Mailbox Folder to store saved voic Messages. This field is read-only. temp_greeting_enabled Flag indicating whether a temporary recorded greeting is used in place of the default greeting. The Route Point. This value must be unique. Use one of the available GET requests to return an available Route Point. Request: GET /api/v4/pbx/routepoint/available/ Request: GET /api/v4/pbx/routepoint/available/? startswith={} resource_uri of the resource. timezone Time zone for the Extension. Use the Time Zone GET request to return a list of available Time Zones. user The User associated with the Extension. Use the User GET request to return a list of available Users. Request: GET /api/v4/access/user/ RETURNS 200 Successfully updated the resource EXAMPLE RESPONSE { "auto_record": true, "available_profiles": "/api/v4/pbx/available_profile_map/54/",

24 } "channel_data": null, "created": " T21:16:57Z", "current_profile": "/api/v4/pbx/handling_profile/189/", "default_area_code": null, "description": null, "display_name": "PUT Extension", "ek": "100", "emergency_ani": null, "endpoints": [], "extension_id": 46, "external_caller_id_": null, "internal_caller_id_name": null, "internal_caller_id_": "100", "intl_calling": false, "is_extension_subtenant": true, "mailbox": { "available_greeting_map": "/api/v4/pbx/available_greeting_map/55/", "created": " T21:16:57Z", "default_greeting": "/api/v4/pbx/voice_recording/62/", "delete_vm": false, "deleted_messages": "/api/v4/pbx/folder/170/", "ek": "100", " _address": null, " _attachment": false, "enabled": true, "mailbox_id": 51, "modified": " T21:16:57Z", "new_messages": "/api/v4/pbx/folder/171/", "pin": "5678", "play_cid": true, "play_envelope": true, "resource_uri": "/api/v4/pbx/mailbox/51/", "saved_messages": "/api/v4/pbx/folder/172/", "temp_greeting_enabled": false }, "modified": " T21:16:57Z", "": "100", "pk": "46", "resource_uri": "/api/v4/pbx/extension/46/", "routepoints": [ "/api/v4/pbx/routepoint/150/" ], "timezone": "", "user": "/api/v4/access/user/289/" auto_record Flag indicating whether all calls on the Extension are automatically recorded. available_profiles The AvailableProfileMap associated with the Extension.

25 channel_data JSON Reserved for future use. created Date/time the resource was created. current_profile The Handling Profile currently being used for the Extension. default_area_code The default area code associated with the external_caller_id_. description The description of the Extension. display_name None The display name for the Extension. ek UUID A unique ID used by the Corvisa platform. emergency_ani The caller ID to send with emergency calls. endpoints array List of Endpoints associated with the Extension. By default, these will all be rung when the User's Extension is dialed. extension_id Unique ID for the Extension. external_caller_id_ The as it appears on the caller ID for the party receiving a call. internal_caller_id_name The name as it appears on the caller ID. internal_caller_id_ The as it appears on the caller ID for internal use. intl_calling Flag indicating whether international calls can be made from the Extension. is_extension_subtenant Flag indicating whether the currently authenticated User's active SubTenant matches the SubTenant associated with this Extension. mailbox JSON Complete representation of the extension's Mailbox.

26 MAILBOX FIELDS available_greeting_map The Available Greeting Map that contains the greetings to play before a message is left. created Date/time Mailbox was created. default_greeting The Voice Recording to use as the default greeting. delete_vm Flag indicating whether voic Messages are deleted automatically after being played. deleted_messages The Mailbox Folder to store deleted voic Messages. ek UUID A unique ID used by the Corvisa platform. _address The address associated with the Mailbox. _attachment Flag indicating whether voic messages are sent as attachments to the associated address. enabled Flag indicating whether the Mailbox is active. mailbox_id Unique ID of the Mailbox associated with the Extension. modified Date/time Mailbox was last modified. new_messages The Mailbox Folder to store new voic Messages. pin Security PIN used to open/unlock the Mailbox. play_cid Flag indicating whether Caller ID information is read before a voic message is played. play_envelope Flag indicating whether the created date and time is read before a voic message is played. resource_uri for the Mailbox resource.

27 saved_messages The Mailbox Folder to store saved voic Messages. temp_greeting_enabled Flag indicating whether a temporary recorded greeting is used in place of the default greeting. modified Date/time the Extension was last modified. The Route Point. pk Numerical ID of the extension. The pk is primary key for the Extension. resource_uri of the resource. routepoints array List of all Route Points associated with the Extension. timezone Time zone for the Extension. user The User associated with the Extension. DELETE /api/v4/pbx/extension/{id}/ Delete an Extension. RETURNS 204 Successfully deleted resource(s) PATCH /api/v4/pbx/extension/{id}/ Patch a single Extension resource. EXAMPLE REQUEST { } "description": "extension 100 description was PATCHed", "user": "/api/v4/access/user/294/"

28 FIELDS description The description of the Extension. user The User associated with the Extension. Use the User GET request to return a list of available Users. Request: GET /api/v4/access/user/ RETURNS 202 Successfully patched the resource EXAMPLE RESPONSE { "auto_record": false, "available_profiles": "/api/v4/pbx/available_profile_map/139/", "channel_data": null, "created": " T21:16:57Z", "current_profile": "/api/v4/pbx/handling_profile/191/", "default_area_code": null, "description": "extension 100 description was PATCHed", "display_name": null, "ek": "100", "emergency_ani": null, "endpoints": [], "extension_id": 48, "external_caller_id_": null, "internal_caller_id_name": null, "internal_caller_id_": "100", "intl_calling": false, "is_extension_subtenant": true, "mailbox": { "available_greeting_map": "/api/v4/pbx/available_greeting_map/59/", "created": " T21:16:57Z", "default_greeting": "/api/v4/pbx/voice_recording/66/", "delete_vm": false, "deleted_messages": "/api/v4/pbx/folder/188/", "ek": "100", " _address": null, " _attachment": false, "enabled": true, "mailbox_id": 55, "modified": " T21:16:57Z",

29 } "new_messages": "/api/v4/pbx/folder/189/", "pin": "1234", "play_cid": true, "play_envelope": true, "resource_uri": "/api/v4/pbx/mailbox/55/", "saved_messages": "/api/v4/pbx/folder/190/", "temp_greeting_enabled": false }, "modified": " T21:16:57Z", "": "100", "resource_uri": "/api/v4/pbx/extension/48/", "routepoints": [ "/api/v4/pbx/routepoint/154/" ], "timezone": "", "user": "/api/v4/access/user/294/" auto_record Flag indicating whether all calls on the Extension are automatically recorded. available_profiles The AvailableProfileMap associated with the Extension. channel_data JSON Reserved for future use. created Date/time the resource was created. current_profile The Handling Profile currently being used for the Extension. default_area_code The default area code associated with the external_caller_id_. description The description of the Extension. display_name None The display name for the Extension. ek UUID A unique ID used by the Corvisa platform. emergency_ani The caller ID to send with emergency calls. endpoints array List of Endpoints associated with the Extension. By default, these will

30 array all be rung when the User's Extension is dialed. extension_id Unique ID for the Extension. external_caller_id_ The as it appears on the caller ID for the party receiving a call. internal_caller_id_name The name as it appears on the caller ID. internal_caller_id_ The as it appears on the caller ID for internal use. intl_calling Flag indicating whether international calls can be made from the Extension. is_extension_subtenant Flag indicating whether the currently authenticated User's active SubTenant matches the SubTenant associated with this Extension. mailbox JSON Complete representation of the extension's Mailbox. MAILBOX FIELDS available_greeting_map The Available Greeting Map that contains the greetings to play before a message is left. created Date/time Mailbox was created. default_greeting The Voice Recording to use as the default greeting. delete_vm Flag indicating whether voic Messages are deleted automatically after being played. deleted_messages The Mailbox Folder to store deleted voic Messages. ek UUID A unique ID used by the Corvisa platform. _address The address associated with the Mailbox. _attachment Flag indicating whether voic messages are sent as attachments to the associated address.

31 enabled Flag indicating whether the Mailbox is active. mailbox_id Unique ID of the Mailbox associated with the Extension. modified Date/time Mailbox was last modified. new_messages The Mailbox Folder to store new voic Messages. pin Security PIN used to open/unlock the Mailbox. play_cid Flag indicating whether Caller ID information is read before a voic message is played. play_envelope Flag indicating whether the created date and time is read before a voic message is played. resource_uri for the Mailbox resource. saved_messages The Mailbox Folder to store saved voic Messages. temp_greeting_enabled Flag indicating whether a temporary recorded greeting is used in place of the default greeting. modified Date/time the Extension was last modified. The Route Point. resource_uri of the resource. routepoints array List of all Route Points associated with the Extension. timezone Time zone for the Extension. user The User associated with the Extension.

32