openapi: 3.2.0 info: title: Phone SMS API description: "You can access information from Zoom with Zoom Phone APIs to build private services or public applications on the [Zoom App Marketplace](https://marketplace.zoom.us/).\n\n To learn how to get your credentials and create private or public applications, see Zoom APIs use [OAuth 2.0 authorization](https://developers.zoom.us/docs/integrations/oauth/). \n\n All endpoints are available through `https` at `api.zoom.us/v2/`. For instance, `https://api.zoom.us/v2/users/` returns all users on an account. You'll receive a `403` error message if you have not set up Zoom Phone." termsOfService: https://zoom.us/docs/en-us/zoom_api_license_and_tou.html contact: name: Zoom Developers url: https://developer.zoom.us/ version: '2' servers: - url: https://api.zoom.us/v2 tags: - name: SMS paths: /phone/sms/messages: post: tags: - SMS summary: Post SMS message description: "Sends [SMS messages](https://support.zoom.us/hc/en-us/articles/360054631031-Setting-up-SMS) to Zoom Phone accounts. \n\n**Service Endpoint SMS**\n* This API now supports sending a Service Endpoint SMS or MMS message.\n* The sender phone number must be assigned to a Service Endpoint and enabled for SMS.\n* Non-Zoom Phone users can send only Service Endpoint SMS or MMS messages. An account-level app is required for non-Zoom Phone users to send Service Endpoint SMS.\n\n**Prerequisites**\n* A Zoom Phone license\n* SMS enabled for the account or admin privileges\n* For Zoom Phone SMS: a Zoom Phone-enabled user\n* For Service Endpoint SMS: an account-level app, SMS enabled for the account, and a Service Endpoint phone number enabled for SMS\n\n**SMS and attachments - Size and limits**\n* SMS size with no media attachments: 2048 bytes\n* SMS size with attachments: 1000 bytes\n* Total attachments: 10\n* Total attachment file size: 2 MB\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:write:admin`,`phone:write`,`phone_sms:write`,`phone_sms:write:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:sms_message`,`phone:read:sms_message:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`" operationId: postSmsMessage requestBody: content: application/json: schema: required: - sender - to_members type: object properties: attachments: maxItems: 10 type: array description: 'A list of multimedia attachments to be sent through MMS. Each item must be a Base 64-encoded image file in a supported format. The following file formats are supported: JPG, PNG, JPEG, GIF. The attachment size limit is 2MB.' items: type: object properties: base64_encoding: type: string description: The ASCII string to send [Base64 encoded](https://en.wikipedia.org/wiki/Base64) attachments as text, the size limit is 2MB. example: SUQzBAAAAAAAZ1RFTkMAAAAIAAADUkVBUEVSAFREUkMAAAAMAAADMjAyMS0w type: type: string description: 'The format of attachments. The following file formats are supported: JPG, PNG, JPEG, GIF, PDF.' example: JPG enum: - PNG - JPEG - JPG - GIF - PDF message: type: string description: The content that is sent as an SMS. Maximum length is 500 characters. Messages will be broken into smaller segments of 160 characters and concatenated at the time of delivery. Unicode characters and emojis are supported. You can also send any text or URL. example: welcome sender: required: - phone_number type: object properties: id: type: string description: The sender's unique user ID. You can pass either `id` or `user_id` in the parameters. example: DnEopNmXQEGU2uvvzjgojw deprecated: true user_id: type: string description: The sender's unique user ID. You can pass either `id` or `user_id` in the parameters. example: DnEopNmXQEGU2uvvzjgojw deprecated: true phone_number: type: string description: An SMS capable phone number allocated to Zoom Phone within the customer account. The number must be in the E.164 format. The phone number must belong to the sender and be assigned to either an user, a call queue, an auto receptionist, or the programmatic API endpoint. Get the number via a valid Zoom Phone Calling Plan or a Zoom Phone Number license. The number can only send messages after fulfilling the in-country compliance requirements. example: '+18108001001' description: The field that describes the sender's identity. session_id: type: string description: The unique ID for the SMS session between sender and recipient. Session IDs are perpetual in nature and maintain the continuity of the conversation. example: d39fc7e14ef9f2b6453f5f02524d79a2 to_members: maxItems: 10 type: array description: The list of recipients. For the US and CA toll numbers, sending to more than one recipient will create a group message with all recipients. For other number types, the messages will be sent to each recipient individually as 1:1 messages. If any recipient number is invalid, there will be an exception. items: required: - phone_number type: object properties: phone_number: type: string description: The phone number of the person receiving the SMS. The recipient phone numbers should be in the E.164 format. Opt in - START - and opt out - STOP - keywords received from these number will be honored. example: '+12058945624' responses: '201': description: "**HTTP Status Code:** `201` \n \nSMS sent successfully." content: application/json: schema: type: object properties: date_time: type: string description: The message creation time in UTC (Coordinated Universal Time). example: '2022-01-17T08:13:27Z' message_id: type: string description: 'The message ID. ' example: E14032F2-1EDE-4D8E-924B-C83A70CD2923 session_id: type: string description: The session ID. example: d39fc7e14ef9f2b6453f5f02524d79a2 '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `2001`
\n Account does not exist.
\n**Error Code:** `1001`
\n User does not exist: {id}.
\n**Error Code:** `1024`
\n User does not exist due to missing required parameters.
\n**Error Code:** `7001`
\n Phone number is not valid.
\n**Error Code:** `316`
\n The phone number does not conform to the E.164 standard.
\n**Error Code:** `300`
\n Unsupported content type.
\n**Error Code:** `135`
\n You cannot access another user.
\n**Error Code:** `121`
\n Unsupported content type for SMS attachments.
\n**Error Code:** `138`
\n Missing content type for SMS attachment.
\n**Error Code:** `140`
\n The SMS attachment file content does not match the specified content type.
\n" '401': description: "**HTTP Status Code:** `401`
\n Unauthorized \n\n **Error Code:** `124`
\n Account does not exist: {accountId}.
\n" '429': description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n " security: - openapi_oauth: - phone:write:admin - phone:write - phone_sms:write - phone_sms:write:admin - phone:read:sms_message - phone:read:sms_message:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:write:admin - phone:write - phone_sms:write - phone_sms:write:admin x-granular-scopes: - phone:read:sms_message - phone:read:sms_message:admin /phone/sms/sessions: get: tags: - SMS summary: Get account's SMS sessions description: 'Returns details about SMS sessions for an account. --- **Service Endpoint SMS** * This API now supports retrieving Service Endpoint SMS sessions. * Non-Zoom Phone users can access only Service Endpoint SMS sessions. An account-level app is required for non-Zoom Phone users to access Service Endpoint SMS. --- **Prerequisites** * Paid account * Zoom Phone enabled for the account * For Zoom Phone SMS: a Zoom Phone-enabled user * For Service Endpoint SMS: an account-level app and a Service Endpoint phone number enabled for SMS **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone_sms:read`,`phone_sms:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_sms_sessions`,`phone:read:list_sms_sessions:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`' operationId: accountSmsSession parameters: - name: page_size in: query description: The number of records returned within a single API call. required: false schema: maximum: 100 type: integer example: 30 default: 30 - name: next_page_token in: query description: The current page number of returned records. required: false schema: type: string example: 2z0Ov7kngllAbfQi4ZR2eQTb3mFVYQpYAe2 - name: from in: query description: "The start time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. \n\nThe date range defined by the `from` and `to` parameters should be a month as the response only includes one month's worth of data at once. \n\nIf unspecified, it returns data from the past 30 days." required: false schema: type: string format: date example: '2021-12-01' - name: to in: query description: "This field is required only when the `from` parameter is specified. \n\nEnd time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format, the same format as the `from` parameter." required: false schema: type: string format: date example: '2021-12-31' - name: session_type in: query description: 'This field filters the session list by session type. The value for this field can be one of the following: * `user` * `call_queue` * `auto_receptionist` * `service_endpoint` * `all`' required: false schema: type: string example: user default: user enum: - user - call_queue - auto_receptionist - service_endpoint - all - name: phone_number in: query description: The sender's or receiver's phone number that limits the list of SMS sessions. required: false schema: type: string example: '18108001001' - name: filter_type in: query description: 'This field filters by `sent_message_time`, `received_message_time`, `last_message_time`, or `sent_received_message_time` for the From and To timestamps. * `last_message_time`: queries which sessions last messages between From and To timestamps. * `sent_message_time`: queries which sessions have sent messages between From and To timestamps. * `received_message_time`: queries which sessions have received messages between From and To timestamps. * `sent_received_message_time`: queries which sessions have either sent or received messages between the From and To timestamps.' required: false schema: type: string example: last_message_time default: last_message_time enum: - sent_message_time - received_message_time - last_message_time - sent_received_message_time responses: '200': description: OK content: application/json: schema: type: object properties: next_page_token: type: string description: The next page token paginates through a large set of results. A next page token returns whenever the set of the available result list exceeds the page size. example: 2z0Ov7kngllAbfQi4ZR2eQTb3mFVYQpYAe3 page_size: type: integer description: The size of each page. example: 30 sms_sessions: maxItems: 100 type: array items: type: object properties: last_access_time: type: string description: The last send or receive time in UTC. example: '2022-03-25T02:11:27Z' participants: maxItems: 10 type: array description: The SMS members. items: type: object properties: display_name: type: string description: The participant name. example: test api owner: type: object properties: id: type: string description: The owner ID. example: DnEopNmXQEGU2uvvzjgojw type: type: string description: 'The owner type: * `user` * `callQueue` * `autoReceptionist` * `sharedLineGroup` * `serviceEndpoint`' example: user enum: - user - callQueue - autoReceptionist - sharedLineGroup - serviceEndpoint phone_number: type: string description: The participant phone number. example: '18108001001' is_session_owner: type: boolean description: Whether it is the owner of the session. example: true extension_status: type: string description: "This field indicates the status of the extension. \n* `inactive` \n* `deleted`" example: deleted enum: - inactive - deleted extension_deleted_time: type: string description: The date time the extension was deleted. It exists only when extension_status is `deleted`. example: '2022-10-14T22:10:54Z' session_id: type: string description: The SMS session ID. example: d39fc7e14ef9f2b6453f5f02524d79a2 session_type: type: string description: 'The session type. The value for this field can be one of the following: * `user` * `call_queue` * `auto_receptionist` * `service_endpoint`' example: user '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `400`
\n SMS session type is invalid.
\n" '401': description: "**HTTP Status Code:** `401`
\n Unauthorized \n\n **Error Code:** `124`
\n Account does not exist: {accountId}.
\n" '404': description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `7012`
\n Error retrieving SMS.
\n" '429': description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n " security: - openapi_oauth: - phone:read:admin - phone_sms:read - phone_sms:read:admin - phone:read:list_sms_sessions - phone:read:list_sms_sessions:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:read:admin - phone_sms:read - phone_sms:read:admin x-granular-scopes: - phone:read:list_sms_sessions - phone:read:list_sms_sessions:admin /phone/sms/sessions/{sessionId}: get: tags: - SMS summary: Get SMS session details description: 'Returns details about an SMS session. **Service Endpoint SMS** * This API now supports retrieving a Service Endpoint SMS session. * The `sessionId` must belong to a Service Endpoint SMS session. * Non-Zoom Phone users can access only Service Endpoint SMS sessions. An account-level app is required for non-Zoom Phone users to access Service Endpoint SMS. **Prerequisites** * A paid account * Zoom Phone enabled for the account * For Zoom Phone SMS: a Zoom Phone-enabled user * For Service Endpoint SMS: an account-level app and a Service Endpoint phone number enabled for SMS **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:read`,`phone_sms:read`,`phone_sms:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:sms_session`,`phone:read:sms_session:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`' operationId: smsSessionDetails parameters: - name: sessionId in: path description: The SMS session ID. required: true schema: type: string example: 35ccd84704253f5f793d0a721c7fe655 - name: page_size in: query description: The number of records returned within a single API call. required: false schema: maximum: 100 type: integer example: 30 default: 30 - name: next_page_token in: query description: The current page number of returned records. required: false schema: type: string example: 2z0Ov7kngllAbfQi4ZR2eQTb3mFVYQpYAe2 - name: from in: query description: The start time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. The date range defined by the `from` and `to` parameters should be a month as the response only includes one month's worth of data at once. If unspecified, returns data from the past 30 days. required: false schema: type: string format: date example: '2021-12-01' - name: to in: query description: '**Required** only when the `from` parameter is specified. End time and date in **yyyy-mm-dd** or **yyyy-MM-dd''T''HH:mm:ss''Z''** format, the same format as the `from` parameter.' required: false schema: type: string format: date example: '2021-12-31' - name: delivery_status in: query description: 'This field filters messages by `all`, `received`, `delivered`, `failed_to_send`, `sent`, `failed_to_deliver`, or `unknown` status. * `all`: searches for messages in any status. (Default) * `received`: queries messages that were successfully received on the Zoom number. * `delivered`: queries messages that were successfully delivered to the intended recipient(s) on the mobile operator''s network. * `failed_to_send`: queries messages that could not be sent from the Zoom network to the mobile operator''s network. * `sent`: queries messages that have been sent to the carrier but a delivery confirmation has not been received yet. * `failed_to_deliver`: queries messages that could not be delivered to the recipient. * `unknown`: queries messages where the system is unable to determine if the delivery was successful.' required: false schema: type: string example: delivered default: all enum: - all - received - delivered - failed_to_send - sent - failed_to_deliver - unknown - name: sort in: query description: 'The order of the SMS to return based on creation time. `1`: ascending `2`: descending' required: false schema: type: integer example: 1 responses: '200': description: OK content: application/json: schema: type: object properties: next_page_token: type: string description: The next page token paginates through a large set of results. It returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes. example: 2z0Ov7kngllAbfQi4ZR2eQTb3mFVYQpYAe4 page_size: type: integer description: The size of the page. example: 30 sms_histories: maxItems: 100 type: array items: type: object properties: attachments: maxItems: 10 type: array items: type: object properties: download_url: type: string description: The download link for the media file. example: https://exampleurl.us/file/download/x18dcVWxTcCzbp4zr2AT3A?jwt=eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJjcm9zc2ZpbGUiLCJhdWQiOiJmaWxlIiwiZGlnIjoiYTZkODE4NzQ2MDNmN2UzZWM4OThkNDMxM2IxNjNhNTQ4NGI4MjkxMTA0ZmQyYzc4MTg1NmY0MGUxY2FlOTI3YyIsImV4cCI6MTY0ODE5NDA1NH0.eCURcan9QOOw9wvBdSn_-TBzgT5HWBzp04IfsK19Oto id: type: string description: The media file ID. example: x18dcVWxTcCzbp4zr2AT3A name: type: string description: The file name. example: FWDHOMaNRaqIvNc3aIdisg.jpg size: type: integer description: The file size. example: 225740 type: type: string description: 'The file type: OTHER, PNG, GIF, JPG, AUDIO, VIDEO' example: JPG/JPEG enum: - OTHER - PNG - GIF - JPG - AUDIO - VIDEO date_time: type: string description: The UTC time the message was created. example: '2022-03-23T02:58:01Z' direction: type: string description: Whether the direction is In or Out. example: In message: type: string description: The contents of the SMS text. example: welcome message_id: type: string description: The message ID. example: IQ-cRH5P5EiTWCwpNzScnECJw delivery_status: type: string description: 'The status of the message. * `received`: The message was successfully received on the Zoom number. * `delivered`: The message was successfully delivered to the intended recipient(s) on the mobile operator''s network. * `failed_to_send`: The message could not be sent from the Zoom network to the mobile operator''s network. * `sent`: The message has been sent to the carrier, but a delivery confirmation has not been received yet. Note that some carriers do not provide delivery confirmations. * `failed_to_deliver`: The message could not be delivered to the recipient. * `unknown`: The system is unable to determine if this message was delivered successfully.' example: delivered enum: - received - delivered - failed_to_send - sent - failed_to_deliver - unknown message_type: type: integer description: "The message type: \n \n1 - SMS \n \n2 - MMS \n \n3 - GROUP_SMS \n \n4 - GROUP_MMS \n \n5 - SMS_INTER \n \n6 - MSG_ON_NET" example: 2 enum: - 1 - 2 - 3 - 4 - 5 - 6 sender: required: - phone_number type: object properties: display_name: type: string description: The sender's name. example: test api owner: type: object properties: id: type: string description: The owner ID. example: DnEopNmXQEGU2uvvzjgojw type: type: string description: 'The owner type: * `user` * `callQueue` * `autoReceptionist` * `sharedLineGroup` * `serviceEndpoint`' example: user enum: - user - callQueue - autoReceptionist - sharedLineGroup - serviceEndpoint phone_number: type: string description: The sender's phone number. example: '18108001001' to_members: maxItems: 10 type: array items: required: - phone_number type: object properties: display_name: type: string description: The participant's name. example: ezreal mao owner: type: object properties: id: type: string description: The owner ID. example: WeD59Hn7SvqNRB9jcxz5NQ type: type: string description: 'The owner type: * `user` * `callQueue` * `autoReceptionist` * `sharedLineGroup` * `serviceEndpoint`' example: user enum: - user - callQueue - autoReceptionist - sharedLineGroup - serviceEndpoint phone_number: type: string description: The receiver's phone number. example: '12092693625' '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `400`
\n The next page token is invalid or expired.\nRequires from and to\npage number should be > 0
\n" '401': description: "**HTTP Status Code:** `401`
\n Unauthorized \n\n **Error Code:** `124`
\n Access token has expired.
\n" '404': description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `2001`
\n Account does not exist.
\n**Error Code:** `7013`
\n Error retrieving SMS history.
\n" '429': description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n " security: - openapi_oauth: - phone:read:admin - phone:read - phone_sms:read - phone_sms:read:admin - phone:read:sms_session - phone:read:sms_session:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:read:admin - phone:read - phone_sms:read - phone_sms:read:admin x-granular-scopes: - phone:read:sms_session - phone:read:sms_session:admin /phone/sms/sessions/{sessionId}/messages/{messageId}: get: tags: - SMS summary: Get SMS by message ID description: 'Returns details about a specific message in an SMS session. **Service Endpoint SMS** * This API supports retrieving a specific message from a Service Endpoint SMS session. * The `sessionId` must belong to a Service Endpoint SMS session, and the `messageId` must belong to that session. * Non-Zoom Phone users can only access messages in Service Endpoint SMS sessions. An account-level app is required for non-Zoom Phone users to access Service Endpoint SMS. **Prerequisites** * A paid account * Zoom Phone enabled for the account * For Zoom Phone SMS: a Zoom Phone-enabled user * For Service Endpoint SMS: an account-level app and a Service Endpoint phone number enabled for SMS **[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:read`,`phone_sms:read`,`phone_sms:read:admin` **[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:sms_message`,`phone:read:sms_message:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`' operationId: smsByMessageId parameters: - name: sessionId in: path description: The SMS session ID. required: true schema: type: string example: d153b9dbe20e662197bda28d00206011 - name: messageId in: path description: The SMS message ID. required: true schema: type: string example: IQ-cRH5P5EiTWCwpNzScnECJw responses: '200': description: OK content: application/json: schema: type: object properties: attachments: maxItems: 10 type: array items: type: object properties: download_url: type: string description: The download link for the media file. example: https://exampleurl.us/file/download/x18dcVWxTcCzbp4zr2AT3A?jwt=eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJjcm9zc2ZpbGUiLCJhdWQiOiJmaWxlIiwiZGlnIjoiYTZkODE4NzQ2MDNmN2UzZWM4OThkNDMxM2IxNjNhNTQ4NGI4MjkxMTA0ZmQyYzc4MTg1NmY0MGUxY2FlOTI3YyIsImV4cCI6MTY0ODE5NDA1NH0.eCURcan9QOOw9wvBdSn_-TBzgT5HWBzp04IfsK19Oto id: type: string description: The media file ID. example: x18dcVWxTcCzbp4zr2AT3A name: type: string description: The file name. example: FWDHOMaNRaqIvNc3aIdisg.jpg size: type: integer description: The file size. example: 225740 type: type: string description: 'The file type: OTHER, PNG, GIF, JPG, AUDIO, VIDEO' example: JPG/JPEG enum: - OTHER - PNG - GIF - JPG - AUDIO - VIDEO date_time: type: string description: The UTC time the message was created. example: '2022-03-23T02:58:01Z' direction: type: string description: The direction is either in or out example: In message: type: string description: The SMS text contents. example: welcome delivery_status: type: string description: 'The status of the message. * `received`: The message was successfully received on the Zoom number. * `delivered`: The message was successfully delivered to the intended recipient(s) on the mobile operator''s network. * `failed_to_send`: The message could not be sent from the Zoom network to the mobile operator''s network. * `sent`: The message has been sent to the carrier, but a delivery confirmation has not been received yet. Note that some carriers do not provide delivery confirmations. * `failed_to_deliver`: The message could not be delivered to the recipient. * `unknown`: The system is unable to determine if this message was delivered successfully.' example: delivered enum: - received - delivered - failed_to_send - sent - failed_to_deliver - unknown message_id: type: string description: The message ID. example: IQ-cRH5P5EiTWCwpNzScnECJw message_type: type: integer description: "The message type: \n \n1 - SMS \n \n2 - MMS \n \n3 - GROUP_SMS \n \n4 - GROUP_MMS \n \n5 - SMS_INTER \n \n6 - MSG_ON_NET" example: 2 enum: - 1 - 2 - 3 - 4 - 5 - 6 sender: required: - phone_number type: object properties: display_name: type: string description: The sender's name. example: ezreal mao owner: type: object properties: id: type: string description: The owner ID. example: WeD59Hn7SvqNRB9jcxz5NQ type: type: string description: 'The owner type: * `user` * `callQueue` * `autoReceptionist` * `sharedLineGroup` * `serviceEndpoint`' example: user enum: - user - callQueue - autoReceptionist - sharedLineGroup - serviceEndpoint phone_number: type: string description: The sender's phone number. example: '12092693625' to_members: maxItems: 10 type: array items: required: - phone_number type: object properties: display_name: type: string description: The participant's name. example: test api owner: type: object properties: id: type: string description: The owner ID. example: DnEopNmXQEGU2uvvzjgojw type: type: string description: 'The owner type: * `user` * `callQueue` * `autoReceptionist` * `sharedLineGroup` * `serviceEndpoint`' example: user enum: - user - callQueue - autoReceptionist - sharedLineGroup - serviceEndpoint phone_number: type: string description: The receiver's phone number. example: '18108001001' '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `1004`
\n Not allow to access this account.
\n" '401': description: "**HTTP Status Code:** `401`
\n Unauthorized \n\n **Error Code:** `124`
\n Access token has expired.
\n" '404': description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `2001`
\n Account does not exist.
\n" '429': description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n " security: - openapi_oauth: - phone:read:admin - phone:read - phone_sms:read - phone_sms:read:admin - phone:read:sms_message - phone:read:sms_message:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:read:admin - phone:read - phone_sms:read - phone_sms:read:admin x-granular-scopes: - phone:read:sms_message - phone:read:sms_message:admin /phone/sms/sessions/{sessionId}/sync: get: tags: - SMS summary: Sync SMS by session ID description: "Syncs SMS messages in a session. \n\n**Service Endpoint SMS**\n* This API now supports syncing a Service Endpoint SMS session.\n* The `sessionId` must belong to a Service Endpoint SMS session.\n* Non-Zoom Phone users can sync only Service Endpoint SMS sessions. An account-level app is required for non-Zoom Phone users to access Service Endpoint SMS.\n\n**Prerequisites**\n* Paid account\n* Zoom Phone enabled for the account\n* For Zoom Phone SMS: a Zoom Phone-enabled user\n* For Service Endpoint SMS: an account-level app and a Service Endpoint phone number enabled for SMS\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:read`,`phone_sms:read`,`phone_sms:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:sms_session`,`phone:read:sms_session:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`" operationId: smsSessionSync parameters: - name: sessionId in: path description: The SMS session ID. required: true schema: type: string example: 35ccd84704253f5f793d0a721c7fe655 - name: sync_type in: query description: "The options for synchronizing SMS message: \n \nFSync - Full sync \n \nISync - Increase sync \n \nBSync - Backward sync" required: false schema: type: string example: FSync enum: - FSync - ISync - BSync - name: count in: query description: The number of records returned within a single API call. required: true schema: maximum: 250 minimum: 1 type: integer example: 100 - name: sync_token in: query description: The time range for returned records. It's used for locating where the next retrieval will begin. required: false schema: type: string example: MFgyQ0Z3UDkwaF8xNjQyNDA3MjA3MDE0XzE2NDI0MDcyMDcwMTQ= responses: '200': description: OK content: application/json: schema: type: object properties: sms_histories: maxItems: 250 type: array items: type: object properties: attachments: maxItems: 10 type: array items: type: object properties: download_url: type: string description: The download link for the media file. example: https://exampleurl.us/file/download/x18dcVWxTcCzbp4zr2AT3A?jwt=eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJjcm9zc2ZpbGUiLCJhdWQiOiJmaWxlIiwiZGlnIjoiYTZkODE4NzQ2MDNmN2UzZWM4OThkNDMxM2IxNjNhNTQ4NGI4MjkxMTA0ZmQyYzc4MTg1NmY0MGUxY2FlOTI3YyIsImV4cCI6MTY0ODE5NDk4OH0.kAh1EnCkjpwAOX_GUfWVPLK2xhnVPRiwm8vDbD-oyVY id: type: string description: The media file ID. example: x18dcVWxTcCzbp4zr2AT3A name: type: string description: The file's name. example: FWDHOMaNRaqIvNc3aIdisg.jpg size: type: integer description: The file's size. example: 225740 type: type: string description: 'The file''s type: OTHER, PNG, GIF, JPG, AUDIO, VIDEO' example: JPG/JPEG enum: - OTHER - PNG - GIF - JPG - AUDIO - VIDEO date_time: type: string description: The UTC time the message was created. example: '2022-03-23T02:58:01Z' direction: type: string description: '`In`(SMS received) or `Out`(SMS sent)' example: In message: type: string description: The content of the SMS. example: welcome message_id: type: string description: The message ID. example: IQ-cRH5P5EiTWCwpNzScnECJw message_type: type: integer description: "The message type: \n \n1 - SMS \n \n2 - MMS \n \n3 - GROUP_SMS \n \n4 - GROUP_MMS \n \n5 - SMS_INTER \n \n6 - MSG_ON_NET" example: 2 enum: - 1 - 2 - 3 - 4 - 5 - 6 sender: required: - phone_number type: object properties: display_name: type: string description: The sender's name. example: test api owner: type: object properties: id: type: string description: The owner ID. example: DnEopNmXQEGU2uvvzjgojw type: type: string description: 'The owner''s type: * `user` * `callQueue` * `autoReceptionist` * `sharedLineGroup` * `serviceEndpoint`' example: user enum: - user - callQueue - autoReceptionist - sharedLineGroup - serviceEndpoint phone_number: type: string description: The sender's phone number. example: '18108001001' to_members: maxItems: 10 type: array items: required: - phone_number type: object properties: display_name: type: string description: The SMS recipient's name. example: callhandling0001@testapi.com owner: type: object properties: id: type: string description: The owner ID. example: rYgfsrduSXWCxr94poMN5g type: type: string description: 'The owner''s type: * `user` * `callQueue` * `autoReceptionist` * `sharedLineGroup` * `serviceEndpoint`' example: user enum: - user - callQueue - autoReceptionist - sharedLineGroup - serviceEndpoint phone_number: type: string description: The SMS recipient phone number. example: '12762924594' sync_token: type: string description: The time range for returned records. It's used for locating where the next retrieval will begin. example: MFgyQ0Z3UDkwaF8xNjQyNDA3MjA3MDE0XzE2NDI0MDcyMDcwMTQ= '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `300`
\n The sync token is invalid or expired. Please resync with the `FSync` method.
\n**Error Code:** `7035`
\n The number of new records exceeds the sync count. Please resync with the `FSync` method.
\n" '401': description: "**HTTP Status Code:** `401`
\n Unauthorized \n\n **Error Code:** `124`
\n Invalid access token.
\n" '404': description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `300`
\n The sync token is invalid or expired.

\n**Error Code:** `12004`
\n Session does not exist: {0}.
\n" '429': description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n " security: - openapi_oauth: - phone:read:admin - phone:read - phone_sms:read - phone_sms:read:admin - phone:read:sms_session - phone:read:sms_session:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:read:admin - phone:read - phone_sms:read - phone_sms:read:admin x-granular-scopes: - phone:read:sms_session - phone:read:sms_session:admin /phone/users/{userId}/sms/sessions: get: tags: - SMS summary: Get user's SMS sessions description: "Returns details about SMS sessions for a user. \n\nFor user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\n**Prerequisites:** \n* Paid account \n* User-enabled Zoom phone\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:read`,`phone_sms:read`,`phone_sms:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:list_sms_sessions`,`phone:read:list_sms_sessions:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`" operationId: userSmsSession parameters: - name: userId in: path description: The user ID, user email, or “me” when using OAuth token. required: true schema: type: string example: DnEopNmXQEGU2uvvzjgojw - name: page_size in: query description: The number of records returned within a single API call. required: false schema: maximum: 100 type: integer example: 30 default: 30 - name: next_page_token in: query description: The current page number of returned records. required: false schema: type: string example: nav48KOj42vYPSG4f0cCdT575bZ980did22 - name: session_type in: query description: "This field filters the specific session list by a session type.\n\nThe value for this field can be one of the following: \n `user` \n `call_queue` \n `auto_receptionist` \n `all`" required: false schema: type: string example: user default: user - name: from in: query description: "The start time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format. \n\nThe date range defined by the `from` and `to` parameters should be a month as the response only includes one month's worth of data at once. \n\nIf unspecified, it returns data from the past 30 days." required: false schema: type: string format: date example: '2021-12-01' - name: to in: query description: "This field is required only when the `from` parameter is specified. \n\nThe end time and date in **yyyy-mm-dd** or **yyyy-MM-dd'T'HH:mm:ss'Z'** format is the same format as the `from` parameter." required: false schema: type: string format: date example: '2021-12-31' - name: phone_number in: query description: The sender's or receiver's phone number that limits the list of SMS sessions. required: false schema: type: string example: '18108001001' - name: filter_type in: query description: 'This field filters by `sent_message_time`, `received_message_time`, `last_message_time`, or `sent_received_message_time` for the From and To timestamps. * `last_message_time`: queries which sessions last messages between From and To timestamps. * `sent_message_time`: queries which sessions have sent messages between From and To timestamps. * `received_message_time`: queries which sessions have received messages between From and To timestamps. * `sent_received_message_time`: queries which sessions have either sent or received messages between the From and To timestamps.' required: false schema: type: string example: last_message_time default: last_message_time enum: - sent_message_time - received_message_time - last_message_time - sent_received_message_time responses: '200': description: OK content: application/json: schema: type: object properties: next_page_token: type: string description: The next page token paginates through large result sets. A next page token returns whenever the set of the available result list exceeds the page size. example: 2z0Ov7kngllAbfQi4ZR2eQTb3mFVYQpYAe4 page_size: type: integer description: The size of each page. example: 30 sms_sessions: maxItems: 100 type: array items: type: object properties: last_access_time: type: string description: The last send or receive time in UTC. example: '2022-03-25T02:11:27Z' participants: maxItems: 10 type: array description: The SMS members. items: type: object properties: display_name: type: string description: The participant's name. example: l api owner: type: object properties: id: type: string description: The owner ID. example: DnEopNmXQEGU2uvvzjgojw type: type: string description: 'The owner type: *`user` *`callQueue` *`autoReceptionist` *`sharedLineGroup`' example: user enum: - user - callQueue - autoReceptionist - sharedLineGroup phone_number: type: string description: The participant phone number. example: '18108001001' is_session_owner: type: boolean description: Whether it is the owner of the session. example: true session_id: type: string description: The SMS session ID. example: d39fc7e14ef9f2b6453f5f02524d79a2 session_type: type: string description: "The session type.\nThe value for this field can be one of the following: \n `user` \n `call_queue` \n `auto_receptionist`" example: user '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `400`
\n SMS session type is invalid.\nThe next page token is invalid or expired.
\n**Error Code:** `300`
\n Invalid user id.
\n" '404': description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `1001`
\n User does not exist: {userId}
\n**Error Code:** `7012`
\n Error retrieving SMS.
\n**Error Code:** `2001`
\n Account does not exist.
\n" '429': description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n " security: - openapi_oauth: - phone:read:admin - phone:read - phone_sms:read - phone_sms:read:admin - phone:read:list_sms_sessions - phone:read:list_sms_sessions:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:read:admin - phone:read - phone_sms:read - phone_sms:read:admin x-granular-scopes: - phone:read:list_sms_sessions - phone:read:list_sms_sessions:admin /phone/users/{userId}/sms/sessions/sync: get: tags: - SMS summary: List user's SMS sessions in descending order description: "Retrieves the user's SMS sessions in descending order. Mirrors the ZP client behavior with the most recent on top.\n\n**Prerequisites:**\n* Paid account \n* User-enabled Zoom phone \n \n \n\n\n\n**[Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:admin`,`phone:read`,`phone_sms:read`,`phone_sms:read:admin`\n\n**[Granular Scopes](https://developers.zoom.us/docs/integrations/oauth-scopes-overview/):** `phone:read:sms_session`,`phone:read:sms_session:admin`\n\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `MEDIUM`" operationId: GetSmsSessions parameters: - name: userId in: path description: The user ID, user email, or “me” when using OAuth token. required: true schema: type: string example: DnEopNmXQEGU2uvvzjgojw - name: sync_type in: query description: 'FSync: Full sync BSync: Backward sync ISync: Forward sync' required: true schema: type: string example: FSync default: FSync enum: - FSync - BSync - ISync - name: sync_token in: query description: The sync token. Use if requesting a backward (`BSync`) or forward (`ISync`) sync. required: false schema: type: string example: MFgyQ0Z3UDkwaF8xNjQyNDA3MjA3MDE0XzE2NDI0MDcyMDcwMTQ= - name: count in: query description: The record count of each query required: false schema: maximum: 250 minimum: 1 type: integer example: 50 - name: session_type in: query description: "This field filters the specific session list by a session type.\nThe value for this field can be one of the following: \n `user` \n `call_queue` \n `auto_receptionist` \n `all`" required: false schema: type: string example: user default: user responses: '200': description: "**HTTP Status Code:** `200` **No Content** \n \nSuccessfully listed the SMS sessions." content: application/json: schema: type: object properties: sms_sessions: maxItems: 250 type: array items: type: object properties: last_access_time: type: string description: The last send or receive time in UTC. example: '2022-03-25T02:11:27Z' latest_message: type: object properties: attachments: maxItems: 10 type: array items: type: object properties: id: type: string description: The media file ID. example: ttllslww type: type: string description: 'The file type: OTHER, PNG, GIF, JPG/JPEG, AUDIO, VIDEO' example: GIF enum: - OTHER - PNG - GIF - JPG/JPEG - AUDIO - VIDEO date_time: type: string description: The UTC time the message was created. example: '2022-03-25T02:11:27Z' direction: type: string description: '`In`(SMS received) or `Out`(SMS sent)' example: Out message: type: string description: The content of the SMS. example: hello message_id: type: string description: The message ID. example: cfc07047-123e-4097-91d4-ac2635d646af message_type: type: integer description: "The message type: \n \n1 - SMS \n \n2 - MMS \n \n3 - GROUP_SMS \n \n4 - GROUP_MMS \n \n5 - SMS_INTER \n \n6 - MSG_ON_NET" example: 6 enum: - 1 - 2 - 3 - 4 - 5 - 6 sender: required: - phone_number type: object properties: display_name: type: string description: The sender's name. example: usersubsetting0001@testapi.com owner: type: object properties: id: type: string description: The owner ID. example: DnEopNmXQEGU2uvvzjgojw type: type: string description: 'The owner type: *`user` *`callQueue` *`autoReceptionist` *`sharedLineGroup`' example: user enum: - user - callQueue - autoReceptionist - sharedLineGroup phone_number: type: string description: The sender's phone number. example: '+18108001001' to_members: maxItems: 10 type: array items: required: - phone_number type: object properties: display_name: type: string description: The participant name. example: test api owner: type: object properties: id: type: string description: The owner ID. example: QOFvOvk7SJeOR2VBfL79_g type: type: string description: 'The owner type: *`user` *`callQueue` *`autoReceptionist` *`sharedLineGroup`' example: user enum: - user - callQueue - autoReceptionist - sharedLineGroup phone_number: type: string description: The receiver's phone number. example: '+13522348840' participants: maxItems: 10 type: array description: The SMS senders and receivers. items: type: object properties: display_name: type: string description: The SMS sender or receiver name. example: usersubsetting0001@testapi.com owner: type: object properties: id: type: string description: The owner ID. example: QOFvOvk7SJeOR2VBfL79_g type: type: string description: 'The owner type: *`user` *`callQueue` *`autoReceptionist` *`sharedLineGroup`' example: user enum: - user - callQueue - autoReceptionist - sharedLineGroup phone_number: type: string description: The SMS sender or receiver phone number. example: '+13522348840' is_session_owner: type: boolean description: Whether it is the owner of the session. example: true session_id: type: string description: The SMS session ID. example: 67e261d9eefb2f87dc8193b4c2aeb1d8 session_type: type: string description: "The session type.\nThe value for this field can be one of the following: \n `user` \n `call_queue` \n `auto_receptionist`" example: user unread_message_count: type: integer description: The number of unread messages. example: 125 sync_token: type: string description: The sync token for a backward (`BSync`) or forward (`ISync`) sync. example: TVR5cXB2b2dmSl8xNjIxNTc0ODQ0MDY3XzE2NDgxNzQyODcwMDk= '400': description: "**HTTP Status Code:** `400`
\n Bad Request \n\n **Error Code:** `400`
\n SMS session type is invalid.
\n**Error Code:** `300`
\n Invalid user id.
\nUser does not exist.
\n**Error Code:** `7035`
\n The number of new records exceeds the sync count. Please resync with the `FSync` method.
\n" '404': description: "**HTTP Status Code:** `404`
\n Not Found \n\n **Error Code:** `2001`
\n Account does not exist.
\n**Error Code:** `300`
\n The sync token is invalid or expired.
\n**Error Code:** `1001`
\n User does not exist: {userId}
\n" '429': description: "**HTTP Status Code:** `429`
\n Too Many Requests. For more information, see [rate limits](https://developers.zoom.us/docs/api/rest/rate-limits/). \n\n " security: - openapi_oauth: - phone:read:admin - phone:read - phone_sms:read - phone_sms:read:admin - phone:read:sms_session - phone:read:sms_session:admin openapi_authorization: [] x-extensions: x-permissions: [] x-macro-scopes: - phone:read:admin - phone:read - phone_sms:read - phone_sms:read:admin x-granular-scopes: - phone:read:sms_session - phone:read:sms_session:admin components: securitySchemes: openapi_authorization: type: apiKey name: Authorization in: header openapi_oauth: type: oauth2 flows: authorizationCode: authorizationUrl: / tokenUrl: '' refreshUrl: '' scopes: phone:read:admin: phone:read:admin phone:read:list_account_settings:admin: phone:read:list_account_settings:admin phone:write:admin: phone:write:admin phone:write:customized_number:admin: phone:write:customized_number:admin phone:read:list_customized_number:admin: phone:read:list_customized_number:admin phone:delete:customized_number:admin: phone:delete:customized_number:admin phone:write:alert_setting:admin: phone:write:alert_setting:admin phone:read:list_alert_settings:admin: phone:read:list_alert_settings:admin phone:read:alert_setting:admin: phone:read:alert_setting:admin phone:patch:alert_setting:admin: phone:patch:alert_setting:admin phone:delete:alert_setting:admin: phone:delete:alert_setting:admin phone:read: phone:read phone:read:audio: phone:read:audio phone:read:audio:admin: phone:read:audio:admin phone:write: phone:write phone:delete:audio: phone:delete:audio phone:delete:audio:admin: phone:delete:audio:admin phone:update:audio: phone:update:audio phone:update:audio:admin: phone:update:audio:admin phone:read:list_audios: phone:read:list_audios phone:read:list_audios:admin: phone:read:list_audios:admin phone:write:audio: phone:write:audio phone:write:audio:admin: phone:write:audio:admin phone:write:batch_audios: phone:write:batch_audios phone:write:batch_audios:admin: phone:write:batch_audios:admin phone:read:list_auto_receptionists:admin: phone:read:list_auto_receptionists:admin phone:write:auto_receptionist:admin: phone:write:auto_receptionist:admin phone:delete:auto_receptionist:admin: phone:delete:auto_receptionist:admin phone:update:auto_receptionist:admin: phone:update:auto_receptionist:admin phone:read:auto_receptionist:admin: phone:read:auto_receptionist:admin phone:read:auto_receptionist_call_handling_setting:admin: phone:read:auto_receptionist_call_handling_setting:admin phone:update:auto_receptionist_call_handling_setting:admin: phone:update:auto_receptionist_call_handling_setting:admin phone:delete:auto_receptionist_number:admin: phone:delete:auto_receptionist_number:admin phone:write:auto_receptionist_number:admin: phone:write:auto_receptionist_number:admin phone:update:auto_receptionist_policy:admin: phone:update:auto_receptionist_policy:admin phone:read:auto_receptionist_policy:admin: phone:read:auto_receptionist_policy:admin phone:delete:auto_receptionist_policy:admin: phone:delete:auto_receptionist_policy:admin phone:write:auto_receptionist_policy:admin: phone:write:auto_receptionist_policy:admin phone:read:auto_receptionist_setting:admin: phone:read:auto_receptionist_setting:admin phone:write:auto_receptionist_setting:admin: phone:write:auto_receptionist_setting:admin phone:update:auto_receptionist_setting:admin: phone:update:auto_receptionist_setting:admin phone:delete:auto_receptionist_setting:admin: phone:delete:auto_receptionist_setting:admin phone:read:list_billing_accounts:admin: phone:read:list_billing_accounts:admin phone:read:billing_account:admin: phone:read:billing_account:admin phone:write:blocked_list:admin: phone:write:blocked_list:admin phone:read:list_blocked_lists:admin: phone:read:list_blocked_lists:admin phone:delete:blocked_list:admin: phone:delete:blocked_list:admin phone:read:blocked_list:admin: phone:read:blocked_list:admin phone:update:blocked_list:admin: phone:update:blocked_list:admin phone:read:list_call_handling_settings:admin: phone:read:list_call_handling_settings:admin phone:update:call_handling_setting:admin: phone:update:call_handling_setting:admin phone:delete:call_handling_setting:admin: phone:delete:call_handling_setting:admin phone:write:call_handling_setting:admin: phone:write:call_handling_setting:admin phone_call_log:read: phone_call_log:read phone_call_log:read:admin: phone_call_log:read:admin phone:read:call_log:admin: phone:read:call_log:admin phone:read:list_call_logs:admin: phone:read:list_call_logs:admin phone:update:call_log:admin: phone:update:call_log:admin phone:read:ai_call_summary: phone:read:ai_call_summary phone:read:ai_call_summary:admin: phone:read:ai_call_summary:admin phone:read:list_call_logs: phone:read:list_call_logs phone_call_log:write: phone_call_log:write phone_call_log:write:admin: phone_call_log:write:admin phone:delete:call_log: phone:delete:call_log phone:delete:call_log:admin: phone:delete:call_log:admin phone:read:list_call_queues:admin: phone:read:list_call_queues:admin phone:write:call_queue:admin: phone:write:call_queue:admin phone:delete:call_queue:admin: phone:delete:call_queue:admin phone:update:call_queue:admin: phone:update:call_queue:admin phone:read:call_queue:admin: phone:read:call_queue:admin phone:read:call_queue_call_handling_setting:admin: phone:read:call_queue_call_handling_setting:admin phone:update:call_queue_call_handling_setting:admin: phone:update:call_queue_call_handling_setting:admin phone:read:call_queue_custom_group:admin: phone:read:call_queue_custom_group:admin phone:write:call_queue_custom_group:admin: phone:write:call_queue_custom_group:admin phone:update:call_queue_custom_group:admin: phone:update:call_queue_custom_group:admin phone:delete:call_queue_custom_group:admin: phone:delete:call_queue_custom_group:admin phone:delete:call_queue_custom_group:master: phone:delete:call_queue_custom_group:master phone:master: phone:master phone:read:call_queue_custom_group:master: phone:read:call_queue_custom_group:master phone:write:call_queue_custom_group_member:admin: phone:write:call_queue_custom_group_member:admin phone:delete:call_queue_custom_group_member:admin: phone:delete:call_queue_custom_group_member:admin phone:write:call_queue_member:admin: phone:write:call_queue_member:admin phone:delete:call_queue_member:admin: phone:delete:call_queue_member:admin phone:read:list_call_queue_members:admin: phone:read:list_call_queue_members:admin phone:write:call_queue_number:admin: phone:write:call_queue_number:admin phone:delete:call_queue_number:admin: phone:delete:call_queue_number:admin phone:read:call_queue_policy:admin: phone:read:call_queue_policy:admin phone:update:call_queue_policy:admin: phone:update:call_queue_policy:admin phone:write:call_queue_policy:admin: phone:write:call_queue_policy:admin phone:delete:call_queue_policy:admin: phone:delete:call_queue_policy:admin phone:read:list_call_queue_recordings:admin: phone:read:list_call_queue_recordings:admin phone:read:call_queue_setting:admin: phone:read:call_queue_setting:admin phone:write:call_queue_setting:admin: phone:write:call_queue_setting:admin phone:delete:call_queue_setting:admin: phone:delete:call_queue_setting:admin phone:update:call_queue_setting:admin: phone:update:call_queue_setting:admin phone:update:carrier_number:admin: phone:update:carrier_number:admin phone:write:carrier_number:admin: phone:write:carrier_number:admin phone:read:list_carrier_numbers:admin: phone:read:list_carrier_numbers:admin phone:delete:carrier_number:admin: phone:delete:carrier_number:admin phone:write:common_area:admin: phone:write:common_area:admin phone:read:common_area:admin: phone:read:common_area:admin phone:read:list_common_area_activation_codes:admin: phone:read:list_common_area_activation_codes:admin phone:write:apply_template_to_common_areas:admin: phone:write:apply_template_to_common_areas:admin phone:delete:common_area:admin: phone:delete:common_area:admin phone:update:common_area:admin: phone:update:common_area:admin phone:read:common_area_call_handling_setting:admin: phone:read:common_area_call_handling_setting:admin phone:update:common_area_call_handling_setting:admin: phone:update:common_area_call_handling_setting:admin phone:write:common_area_calling_plan:admin: phone:write:common_area_calling_plan:admin phone:delete:common_area_calling_plan:admin: phone:delete:common_area_calling_plan:admin phone:write:common_area_number:admin: phone:write:common_area_number:admin phone:delete:common_area_number:admin: phone:delete:common_area_number:admin phone:read:list_common_area_settings:admin: phone:read:list_common_area_settings:admin phone:update:common_area_setting:admin: phone:update:common_area_setting:admin phone:delete:common_area_setting:admin: phone:delete:common_area_setting:admin phone:write:common_area_setting:admin: phone:write:common_area_setting:admin phone:read:call_qos:admin: phone:read:call_qos:admin phone:read:default_emergency_address:admin: phone:read:default_emergency_address:admin phone:read:detectable_personal_location:admin: phone:read:detectable_personal_location:admin phone:read:location_sharing_permission:admin: phone:read:location_sharing_permission:admin phone:read:nomadic_emergency_services:admin: phone:read:nomadic_emergency_services:admin phone:read:realtime_location_devices:admin: phone:read:realtime_location_devices:admin phone:read:realtime_location_users:admin: phone:read:realtime_location_users:admin phone:read:list_tracked_locations:admin: phone:read:list_tracked_locations:admin phone:update:device_line_keys: phone:update:device_line_keys phone:update:device_line_keys:admin: phone:update:device_line_keys:admin phone:read:device_line_keys: phone:read:device_line_keys phone:read:device_line_keys:admin: phone:read:device_line_keys:admin phone:delete:directory:admin: phone:delete:directory:admin phone:read:directory:admin: phone:read:directory:admin phone:write:directory:admin: phone:write:directory:admin phone:write:emergency_address:admin: phone:write:emergency_address:admin phone:read:list_emergency_addresses:admin: phone:read:list_emergency_addresses:admin phone:read:emergency_address:admin: phone:read:emergency_address:admin phone:delete:emergency_address:admin: phone:delete:emergency_address:admin phone:update:emergency_address:admin: phone:update:emergency_address:admin phone:write:batch_emergency_locations:admin: phone:write:batch_emergency_locations:admin phone:read:list_emergency_locations:admin: phone:read:list_emergency_locations:admin phone:write:emergency_location:admin: phone:write:emergency_location:admin phone:read:emergency_location:admin: phone:read:emergency_location:admin phone:update:emergency_location:admin: phone:update:emergency_location:admin phone:delete:emergency_location:admin: phone:delete:emergency_location:admin phone:write:external_contact:admin: phone:write:external_contact:admin phone:read:list_external_contacts:admin: phone:read:list_external_contacts:admin phone:delete:external_contact:admin: phone:delete:external_contact:admin phone:read:external_contact:admin: phone:read:external_contact:admin phone:update:external_contact:admin: phone:update:external_contact:admin phone:write:send_fax: phone:write:send_fax phone:write:send_fax:admin: phone:write:send_fax:admin phone:read:list_fax_log: phone:read:list_fax_log phone:read:list_fax_log:admin: phone:read:list_fax_log:admin phone:read:fax_log:admin: phone:read:fax_log:admin phone:read:fax_log: phone:read:fax_log phone:delete:fax_log: phone:delete:fax_log phone:delete:fax_log:admin: phone:delete:fax_log:admin phone:read:list_firmware_update_rules:admin: phone:read:list_firmware_update_rules:admin phone:write:firmware_update_rule:admin: phone:write:firmware_update_rule:admin phone:delete:firmware_update_rule:admin: phone:delete:firmware_update_rule:admin phone:update:firmware_update_rule:admin: phone:update:firmware_update_rule:admin phone:read:firmware_update_rule:admin: phone:read:firmware_update_rule:admin phone:read:list_firmwares:admin: phone:read:list_firmwares:admin phone:read:list_call_pickup_groups:admin: phone:read:list_call_pickup_groups:admin phone:write:call_pickup_group:admin: phone:write:call_pickup_group:admin phone:read:call_pickup_group:admin: phone:read:call_pickup_group:admin phone:update:call_pickup_group:admin: phone:update:call_pickup_group:admin phone:delete:call_pickup_group:admin: phone:delete:call_pickup_group:admin phone:write:call_pickup_group_member:admin: phone:write:call_pickup_group_member:admin phone:read:call_pickup_group_member:admin: phone:read:call_pickup_group_member:admin phone:delete:call_pickup_group_member:admin: phone:delete:call_pickup_group_member:admin phone:update:group_policy:admin: phone:update:group_policy:admin phone:read:group_policy:admin: phone:read:group_policy:admin phone:read:group_setting:admin: phone:read:group_setting:admin phone:read:auto_receptionist_ivr:admin: phone:read:auto_receptionist_ivr:admin phone:update:auto_receptionist_ivr:admin: phone:update:auto_receptionist_ivr:admin phone:read:list_extension_inbound_block_rules:admin: phone:read:list_extension_inbound_block_rules:admin phone:read:list_extension_inbound_block_rules: phone:read:list_extension_inbound_block_rules phone:delete:extension_inbound_block_rule:admin: phone:delete:extension_inbound_block_rule:admin phone:delete:extension_inbound_block_rule: phone:delete:extension_inbound_block_rule phone:write:extension_inbound_block_rule:admin: phone:write:extension_inbound_block_rule:admin phone:write:extension_inbound_block_rule: phone:write:extension_inbound_block_rule phone:delete:extension_inbound_block_rule_stat:admin: phone:delete:extension_inbound_block_rule_stat:admin phone:read:list_extension_inbound_block_rules_stat:admin: phone:read:list_extension_inbound_block_rules_stat:admin phone:update:inbound_blocked_for_all:admin: phone:update:inbound_blocked_for_all:admin phone:delete:inbound_block_rule:admin: phone:delete:inbound_block_rule:admin phone:read:list_inbound_block_rules:admin: phone:read:list_inbound_block_rules:admin phone:write:inbound_block_rule:admin: phone:write:inbound_block_rule:admin phone:update:inbound_block_rule:admin: phone:update:inbound_block_rule:admin phone:update:line_keys: phone:update:line_keys phone:update:line_keys:admin: phone:update:line_keys:admin phone:read:line_keys: phone:read:line_keys phone:read:line_keys:admin: phone:read:line_keys:admin phone:delete:line_keys: phone:delete:line_keys phone:delete:line_keys:admin: phone:delete:line_keys:admin phone:read:list_monitoring_groups:admin: phone:read:list_monitoring_groups:admin phone:write:monitoring_group:admin: phone:write:monitoring_group:admin phone:delete:monitoring_group:admin: phone:delete:monitoring_group:admin phone:update:monitoring_group:admin: phone:update:monitoring_group:admin phone:read:monitoring_group:admin: phone:read:monitoring_group:admin phone:read:list_monitoring_group_members:admin: phone:read:list_monitoring_group_members:admin phone:write:monitoring_group_member:admin: phone:write:monitoring_group_member:admin phone:delete:monitoring_group_member:admin: phone:delete:monitoring_group_member:admin phone:read:common_area_outbound_calling_rule:admin: phone:read:common_area_outbound_calling_rule:admin phone:update:common_area_outbound_calling_rule:admin: phone:update:common_area_outbound_calling_rule:admin phone:write:common_area_outbound_calling_rule:admin: phone:write:common_area_outbound_calling_rule:admin phone:delete:common_area_outbound_calling_rule:admin: phone:delete:common_area_outbound_calling_rule:admin phone:read:list_outbound_calling_rules:admin: phone:read:list_outbound_calling_rules:admin phone:update:outbound_calling_rule:admin: phone:update:outbound_calling_rule:admin phone:write:outbound_calling_rule:admin: phone:write:outbound_calling_rule:admin phone:delete:outbound_calling_rule:admin: phone:delete:outbound_calling_rule:admin phone:update:site_outbound_calling_rule:admin: phone:update:site_outbound_calling_rule:admin phone:read:site_outbound_calling_rule:admin: phone:read:site_outbound_calling_rule:admin phone:write:site_outbound_calling_rule:admin: phone:write:site_outbound_calling_rule:admin phone:delete:site_outbound_calling_rule:admin: phone:delete:site_outbound_calling_rule:admin phone:update:user_outbound_calling_rule:admin: phone:update:user_outbound_calling_rule:admin phone:read:user_outbound_calling_rule:admin: phone:read:user_outbound_calling_rule:admin phone:write:user_outbound_calling_rule:admin: phone:write:user_outbound_calling_rule:admin phone:delete:user_outbound_calling_rule:admin: phone:delete:user_outbound_calling_rule:admin phone:read:list_devices:admin: phone:read:list_devices:admin phone:write:device:admin: phone:write:device:admin phone:write:sync_device:admin: phone:write:sync_device:admin phone:update:device:admin: phone:update:device:admin phone:delete:device:admin: phone:delete:device:admin phone:read:device:admin: phone:read:device:admin phone:write:device_extension:admin: phone:write:device_extension:admin phone:delete:device_extension:admin: phone:delete:device_extension:admin phone:update:device_provision_template:admin: phone:update:device_provision_template:admin phone:write:reboot_device:admin: phone:write:reboot_device:admin phone:write:byo_carrier_number:admin: phone:write:byo_carrier_number:admin phone:delete:number:admin: phone:delete:number:admin phone:read:list_numbers:admin: phone:read:list_numbers:admin phone:update:site_number:admin: phone:update:site_number:admin phone:read:numbers:admin: phone:read:numbers:admin phone:update:number:admin: phone:update:number:admin phone:write:user_number: phone:write:user_number phone:write:user_number:admin: phone:write:user_number:admin phone:delete:user_number: phone:delete:user_number phone:delete:user_number:admin: phone:delete:user_number:admin phone:read:list_calling_plans:admin: phone:read:list_calling_plans:admin phone:read:list_roles:admin: phone:read:list_roles:admin phone:write:role:admin: phone:write:role:admin phone:update:role:admin: phone:update:role:admin phone:read:role:admin: phone:read:role:admin phone:delete:role:admin: phone:delete:role:admin phone:read:role_member:admin: phone:read:role_member:admin phone:write:role_member:admin: phone:write:role_member:admin phone:delete:role_member:admin: phone:delete:role_member:admin phone:write:private_directory_member:admin: phone:write:private_directory_member:admin phone:read:list_private_directory_members:admin: phone:read:list_private_directory_members:admin phone:update:private_directory_member:admin: phone:update:private_directory_member:admin phone:delete:private_directory_member:admin: phone:delete:private_directory_member:admin phone_peering:read:admin: phone_peering:read:admin phone:read:list_peering_numbers:admin: phone:read:list_peering_numbers:admin phone_peering:write:admin: phone_peering:write:admin phone:write:peering_number:admin: phone:write:peering_number:admin phone:delete:peering_number:admin: phone:delete:peering_number:admin phone:update:peering_number:admin: phone:update:peering_number:admin phone:write:provision_template:admin: phone:write:provision_template:admin phone:read:list_provision_templates:admin: phone:read:list_provision_templates:admin phone:update:provision_template:admin: phone:update:provision_template:admin phone:read:provision_template:admin: phone:read:provision_template:admin phone:delete:provision_template:admin: phone:delete:provision_template:admin phone_recording:read: phone_recording:read phone_recording:read:admin: phone_recording:read:admin phone:read:call_recording: phone:read:call_recording phone:read:call_recording:admin: phone:read:call_recording:admin phone:read:recording_transcript: phone:read:recording_transcript phone:read:recording_transcript:admin: phone:read:recording_transcript:admin phone:read:list_call_recordings:admin: phone:read:list_call_recordings:admin phone_recording:write: phone_recording:write phone_recording:write:admin: phone_recording:write:admin phone:update:call_recording: phone:update:call_recording phone:update:call_recording:admin: phone:update:call_recording:admin phone:delete:call_recording: phone:delete:call_recording phone:delete:call_recording:admin: phone:delete:call_recording:admin phone:read:list_recordings: phone:read:list_recordings phone:read:list_recordings:admin: phone:read:list_recordings:admin phone:read:call_charges:admin: phone:read:call_charges:admin phone:read:fax_charges:admin: phone:read:fax_charges:admin phone:read:operation_logs:admin: phone:read:operation_logs:admin phone:read:sms_charges:admin: phone:read:sms_charges:admin phone:read:list_routing_rules:admin: phone:read:list_routing_rules:admin phone:write:routing_rule:admin: phone:write:routing_rule:admin phone:update:routing_rule:admin: phone:update:routing_rule:admin phone:read:routing_rule:admin: phone:read:routing_rule:admin phone:delete:routing_rule:admin: phone:delete:routing_rule:admin phone_sms:write: phone_sms:write phone_sms:write:admin: phone_sms:write:admin phone:read:sms_message: phone:read:sms_message phone:read:sms_message:admin: phone:read:sms_message:admin phone_sms:read: phone_sms:read phone_sms:read:admin: phone_sms:read:admin phone:read:list_sms_sessions: phone:read:list_sms_sessions phone:read:list_sms_sessions:admin: phone:read:list_sms_sessions:admin phone:read:sms_session: phone:read:sms_session phone:read:sms_session:admin: phone:read:sms_session:admin phone:read:list_sms_campaigns:admin: phone:read:list_sms_campaigns:admin phone:read:sms_campaign:admin: phone:read:sms_campaign:admin phone:write:sms_campaign_number:admin: phone:write:sms_campaign_number:admin phone:read:sms_campaign_number_opt_status:admin: phone:read:sms_campaign_number_opt_status:admin phone:update:sms_campaign_number_opt_status:admin: phone:update:sms_campaign_number_opt_status:admin phone:delete:sms_campaign_number:admin: phone:delete:sms_campaign_number:admin phone:read:sms_campaign_number_opt_status: phone:read:sms_campaign_number_opt_status phone:read:sms_consent_number_opt_status:admin: phone:read:sms_consent_number_opt_status:admin phone:write:setting_template:admin: phone:write:setting_template:admin phone:read:list_setting_templates:admin: phone:read:list_setting_templates:admin phone:update:setting_template:admin: phone:update:setting_template:admin phone:read:setting_template:admin: phone:read:setting_template:admin phone:update:policy:admin: phone:update:policy:admin phone:read:policy:admin: phone:read:policy:admin phone:read:list_ported_numbers:admin: phone:read:list_ported_numbers:admin phone:read:ported_number:admin: phone:read:ported_number:admin phone:update:settings:admin: phone:update:settings:admin phone:read:settings:admin: phone:read:settings:admin phone:read:list_sip_groups:admin: phone:read:list_sip_groups:admin phone:read:list_sip_trunks:admin: phone:read:list_sip_trunks:admin phone:read:list_shared_line_appearances:admin: phone:read:list_shared_line_appearances:admin phone:read:list_shared_line_groups:admin: phone:read:list_shared_line_groups:admin phone:write:shared_line_group:admin: phone:write:shared_line_group:admin phone:read:shared_line_group:admin: phone:read:shared_line_group:admin phone:read:shared_line_group_call_handling_setting:admin: phone:read:shared_line_group_call_handling_setting:admin phone:update:shared_line_group_call_handling_setting:admin: phone:update:shared_line_group_call_handling_setting:admin phone:read:shared_line_group_policy:admin: phone:read:shared_line_group_policy:admin phone:update:shared_line_group_policy:admin: phone:update:shared_line_group_policy:admin phone:read:shared_line_group_setting:admin: phone:read:shared_line_group_setting:admin phone:update:shared_line_group_setting:admin: phone:update:shared_line_group_setting:admin phone:delete:shared_line_group_setting:admin: phone:delete:shared_line_group_setting:admin phone:write:shared_line_group_setting:admin: phone:write:shared_line_group_setting:admin phone:update:shared_line_group:admin: phone:update:shared_line_group:admin phone:delete:shared_line_group:admin: phone:delete:shared_line_group:admin phone:delete:shared_line_member:admin: phone:delete:shared_line_member:admin phone:write:shared_line_member:admin: phone:write:shared_line_member:admin phone:delete:shared_line_group_number:admin: phone:delete:shared_line_group_number:admin phone:write:shared_line_group_number:admin: phone:write:shared_line_group_number:admin phone:delete:shared_line_group_policy:admin: phone:delete:shared_line_group_policy:admin phone:write:shared_line_group_policy:admin: phone:write:shared_line_group_policy:admin phone:read:list_sites:admin: phone:read:list_sites:admin phone:write:site:admin: phone:write:site:admin phone:read:site:admin: phone:read:site:admin phone:delete:site:admin: phone:delete:site:admin phone:update:site:admin: phone:update:site:admin phone:read:list_site_customized_number:admin: phone:read:list_site_customized_number:admin phone:delete:site_customized_number:admin: phone:delete:site_customized_number:admin phone:write:site_customized_number:admin: phone:write:site_customized_number:admin phone:read:site_setting:admin: phone:read:site_setting:admin phone:write:site_setting:admin: phone:write:site_setting:admin phone:delete:site_setting:admin: phone:delete:site_setting:admin phone:update:site_setting:admin: phone:update:site_setting:admin phone:read:list_users:admin: phone:read:list_users:admin phone:write:batch_users:admin: phone:write:batch_users:admin phone:update:batch_users:admin: phone:update:batch_users:admin phone:read:user: phone:read:user phone:read:user:admin: phone:read:user:admin phone:update:user: phone:update:user phone:update:user:admin: phone:update:user:admin phone:delete:user_call_handling_setting: phone:delete:user_call_handling_setting phone:delete:user_call_handling_setting:admin: phone:delete:user_call_handling_setting:admin phone:write:user_call_handling_setting: phone:write:user_call_handling_setting phone:write:user_call_handling_setting:admin: phone:write:user_call_handling_setting:admin phone:read:user_call_handling_setting:admin: phone:read:user_call_handling_setting:admin phone:read:user_call_handling_setting: phone:read:user_call_handling_setting phone:update:user_call_handling_setting:admin: phone:update:user_call_handling_setting:admin phone:update:user_call_handling_setting: phone:update:user_call_handling_setting phone:write:calling_plan: phone:write:calling_plan phone:write:calling_plan:admin: phone:write:calling_plan:admin phone:update:calling_plan: phone:update:calling_plan phone:update:calling_plan:admin: phone:update:calling_plan:admin phone:delete:users_calling_plan: phone:delete:users_calling_plan phone:delete:users_calling_plan:admin: phone:delete:users_calling_plan:admin phone:read:list_user_customized_number: phone:read:list_user_customized_number phone:read:list_user_customized_number:admin: phone:read:list_user_customized_number:admin phone:write:user_customized_number: phone:write:user_customized_number phone:write:user_customized_number:admin: phone:write:user_customized_number:admin phone:delete:user_customized_number: phone:delete:user_customized_number phone:delete:user_customized_number:admin: phone:delete:user_customized_number:admin phone:update:user_policy:admin: phone:update:user_policy:admin phone:read:user_policy:admin: phone:read:user_policy:admin phone:delete:user_setting: phone:delete:user_setting phone:delete:user_setting:admin: phone:delete:user_setting:admin phone:write:user_setting:admin: phone:write:user_setting:admin phone:write:user_setting: phone:write:user_setting phone:read:user_setting:admin: phone:read:user_setting:admin phone:read:user_setting: phone:read:user_setting phone:update:user_setting: phone:update:user_setting phone:update:user_setting:admin: phone:update:user_setting:admin phone:update:shared_setting: phone:update:shared_setting phone:update:shared_setting:admin: phone:update:shared_setting:admin phone:write:shared_setting: phone:write:shared_setting phone:write:shared_setting:admin: phone:write:shared_setting:admin phone:delete:shared_setting: phone:delete:shared_setting phone:delete:shared_setting:admin: phone:delete:shared_setting:admin phone_voicemail:read: phone_voicemail:read phone_voicemail:read:admin: phone_voicemail:read:admin phone:read:voicemail: phone:read:voicemail phone:read:voicemail:admin: phone:read:voicemail:admin phone:read:list_voicemails: phone:read:list_voicemails phone:read:list_voicemails:admin: phone:read:list_voicemails:admin phone_voicemail:write: phone_voicemail:write phone_voicemail:write:admin: phone_voicemail:write:admin phone:update:voicemail: phone:update:voicemail phone:update:voicemail:admin: phone:update:voicemail:admin phone:delete:voicemail: phone:delete:voicemail phone:delete:voicemail:admin: phone:delete:voicemail:admin phone:read:list_rooms:admin: phone:read:list_rooms:admin phone:write:room:admin: phone:write:room:admin phone:read:room:admin: phone:read:room:admin phone:delete:room:admin: phone:delete:room:admin phone:update:room:admin: phone:update:room:admin phone:write:room_calling_plan:admin: phone:write:room_calling_plan:admin phone:delete:room_calling_plan:admin: phone:delete:room_calling_plan:admin phone:write:room_phone_number:admin: phone:write:room_phone_number:admin phone:delete:room_phone_number:admin: phone:delete:room_phone_number:admin externalDocs: description: Find out more about Swagger url: https://swagger.io