> ## Documentation Index > Fetch the complete documentation index at: https://developers.phonovation.com/llms.txt > Use this file to discover all available pages before exploring further. # Create subscription > This method will create a new subscription. You can provide an ID of an existing profile, or submit a full definition of a profile and security settings if you want to create new ones. **Required scope:** Enable one of: `subscriptions:manage`. ## OpenAPI ````yaml /openapi/phonovation-whatsapp.json post /subscriptions/1/subscription/{channel} openapi: 3.1.0 info: title: Phonovation Messaging APIs description: >- OpenAPI specification for Phonovation messaging, customer engagement, and platform APIs. contact: name: Phonovation support email: support@phonovation.com version: 3.250.0 x-generatedAt: '2026-10-15T11:28:56.135064395Z' servers: - url: https://api.messaging.phonovation.com description: Phonovation Messaging API production server security: [] tags: - name: customer-engagement description: > Complete solutions that will help you drive better outcomes for your customers and business across the entire customer journey. x-type: category x-displayName: Customer Engagement - name: people description: > Build rich profiles for each person to create audience segments for more precise targeting. Manage duplicates and import your data over API. Events reflect actions that end users take on your website or in your mobile application. Events API is a robust way to send those events to Phonovation. Event can be sent only to an existing person in People module and an event definition should be created beforehand to describe contents of the event. Other events tracking options: * [ JavaScript SDK ](https://github.com/phonovation/people-web-sdk) * [iOS SDK](https://github.com/phonovation/mobile-messaging-sdk-ios/wiki/Events) * [Android SDK](https://github.com/phonovation/mobile-messaging-sdk-android/wiki/Events) x-type: product x-displayName: People - name: person-profile description: '' x-type: section x-displayName: Person profile - name: company-profile description: '' x-type: section x-displayName: Company profile - name: tags description: '' x-type: section x-displayName: Tags - name: custom-attributes description: '' x-type: section x-displayName: Custom attributes - name: custom-attributes-lists description: '' x-type: section x-displayName: 'Custom attributes: Lists' - name: contact-information:-push description: '' x-type: section x-displayName: 'Contact Information: Push' - name: events description: '' x-type: section x-displayName: Events - name: segments description: '' x-type: section x-displayName: Segments - name: moments description: > Use Moments to set up and manage automated messaging campaigns with your customers by building conversation workflows. x-type: product x-displayName: Moments - name: flow description: > [Flow](https://www.phonovation.com/docs/moments/manage-flow) is the Phonovation communication builder that helps you create and manage messaging campaigns. The Flows API allows you to add or remove people from communication programmatically for flows with an [active status](https://www.phonovation.com/docs/moments/manage-flow#launch-create). Use the Add Participants to flow endpoint to a person or batches of persons (between 1-1000 persons). The method works asynchronously to queue and process participants at a rate of 10 requests per second. For reporting of operation results, use the notifyUrl field to provide a URL of your callback server that will receive a status report or use the Get a report on participants added to Flow endpoint. x-type: module x-displayName: Flow - name: conversations description: >- Conversations is a solution that allows Enterprises to engage in conversations with their customers over multiple channels. The solution is available either as a web-based cloud platform web interface or over HTTP API for 2-way messaging over SMS, WhatsApp, Viber, and Facebook messenger. It supports conversation threading, conversation management including queues and routing, agent assignment, resolution management and conversation history overview. x-type: product x-displayName: Conversations - name: conversation-management description: '' x-type: section x-displayName: Conversation management - name: conversation-tags description: '' x-type: section x-displayName: Conversation tags - name: conversation-messages description: '' x-type: section x-displayName: Conversation messages - name: conversation-events description: '' x-type: section x-displayName: Conversation events - name: conversation-notes description: '' x-type: section x-displayName: Conversation notes - name: conversation-agents description: '' x-type: section x-displayName: Conversation agents - name: conversation-queues description: '' x-type: section x-displayName: Conversation queues - name: conversation-routing description: '' x-type: section x-displayName: Conversation routing - name: bots description: '' x-type: section x-displayName: Bots - name: metadata description: '' x-type: section x-displayName: Metadata - name: templates description: '' x-type: section x-displayName: Templates - name: conversation-forms description: '' x-type: section x-displayName: Conversation forms - name: account-configuration description: '' x-type: section x-displayName: Account Configuration - name: agent-configuration-calls description: '' x-type: section x-displayName: Agent Configuration (Calls) - name: outbound-call-conversation-calls description: '' x-type: section x-displayName: Outbound Call Conversation (Calls) - name: waiting-strategies-calls description: '' x-type: section x-displayName: Waiting Strategies (Calls) - name: recording-configuration-calls description: '' x-type: section x-displayName: Recording Configuration (Calls) - name: recording-metadata-calls description: '' x-type: section x-displayName: Recording metadata (Calls) - name: recording-calls description: '' x-type: section x-displayName: Recording (Calls) - name: wrap-up-configuration-calls description: '' x-type: section x-displayName: Wrap Up Configuration (Calls) - name: wrap-up-time-calls description: '' x-type: section x-displayName: Wrap Up Time (Calls) - name: transfers-calls description: '' x-type: section x-displayName: Transfers (Calls) - name: transfer-to-external-number-configuration-calls description: '' x-type: section x-displayName: Transfer to External Number Configuration (Calls) - name: transfer-strategy-calls description: '' x-type: section x-displayName: Transfer Strategy (Calls) - name: call-hold-calls description: '' x-type: section x-displayName: Call Hold (Calls) - name: hold-configuration-calls description: '' x-type: section x-displayName: Hold Configuration (Calls) - name: call-timeout-calls description: '' x-type: section x-displayName: Call Timeout (Calls) - name: working-hours description: '' x-type: section x-displayName: Working Hours - name: tts-options-calls description: '' x-type: section x-displayName: TTS options (Calls) - name: away-audio-messages description: '' x-type: section x-displayName: Away Audio Messages - name: web-forms description: '' x-type: section x-displayName: Web Forms - name: answers description: > Answers is the Phonovation fully-encompassed chatbot building platform that enables you to build, test, and deploy highly customized chatbots of different types. Multiple channels are supported on Answers like WhatsApp, Facebook Messenger, Live Chat, Apple Business Chat, Viber, Google Business Messaging and other. Communication with Bot is achieved through existing Conversations solution infrastructure which enables integration and switching between communicating with bot and a live agent. Processing can start by receiving MO message or by receiving a trigger event. Users can manage bots (create, update, delete, start and stop bots) through a web interface. For more details, visit the [Answers documentation](https://www.phonovation.com/docs/answers). Answers API is in Early access stage. x-type: product x-displayName: Answers - name: answers-testing-start-test description: '' x-type: section x-displayName: Start Answers test - name: answers-testing-stop-test description: '' x-type: section x-displayName: Stop Answers test - name: answers-testing-send-message description: '' x-type: section x-displayName: Send inbound message to test - name: common-assets description: > Reuse assets created on Phonovation SaaS products in order to recreate configuration more easily on a single or across multiple accounts. Export or share Moments flows, Answers chatbots or other SaaS assets from your account and import it on another one. This feature is in Early access stage. x-type: product x-displayName: Common Assets - name: saas-resource-export description: '' x-type: section x-displayName: Export resource - name: saas-resource-import description: '' x-type: section x-displayName: Import resource - name: saas-resource-share description: '' x-type: section x-displayName: Share resource - name: saas-status-request description: '' x-type: section x-displayName: Get SaaS request status - name: knowledge-base description: >- Knowledge Base is a centralized content management system for creating, organizing, and retrieving articles, attachments, and structured content. Content is organized into categories, folders, and a hierarchical content tree. Articles support draft and published workflow statuses, tagging, commenting, and file attachments. x-type: product x-displayName: Knowledge Base - name: knowledge-base-search description: '' x-type: section x-displayName: Search - name: knowledge-base-articles description: '' x-type: section x-displayName: Articles - name: knowledge-base-categories description: '' x-type: section x-displayName: Categories - name: knowledge-base-folders description: '' x-type: section x-displayName: Folders - name: knowledge-base-content-tree description: '' x-type: section x-displayName: Content Tree - name: knowledge-base-tags description: '' x-type: section x-displayName: Tags - name: knowledge-base-attachments description: '' x-type: section x-displayName: Attachments - name: ai-hub description: > AI-powered tools and services to help you create smarter and more personalized customer experiences. x-type: category x-displayName: AI Hub - name: ai-assistants description: > Phonovation AI assistant is a retrieval-augmented generation (RAG) solution that performs tasks based on documents and instructions you specify. This means the AI draws answers directly from your documents, resulting in more accurate and relevant responses. For more information on use cases and how to build AI assistants, visit our [AI Assistant](https://www.phonovation.com/docs/ai-hub/ai-assistant) product documentation. With AI Assistants API, you can: * Query your existing AI assistants created via [Phonovation Portal](https://www.phonovation.com/docs/ai-hub/ai-assistant/create-ai-assistant) * Retrieve context the AI assistant uses to answer your queries x-type: product x-displayName: AI Assistants - name: channels description: > Create a perfect customer experience by using the channels your customer already use and love. x-type: category x-displayName: Channels - name: sms description: > SMS (Short Message Service) is the most extensive messaging service available in terms of reach and coverage. A SMS can be sent to and from any mobile device in the world and does not necessarily require a data connection. Phonovation SMS API allows you to send and receive text messages (SMS), fetch or receive delivery reports on your endpoint in real time, and see message logs. You can send messages in different languages, schedule your messages, define delivery time window, and much more. To utilize SMS in combination with other channels, check out [Messages API](https://www.phonovation.com/docs/api/platform/messages-api). x-type: product x-displayName: SMS - name: outbound-sms description: > When you send an SMS to a phone number belonging to an end user's device you are sending an Outbound SMS. Historically, this was and still is referred to as a Mobile Terminated (MT) SMS, though nowadays an SMS is not always sent to a mobile device. In an Outbound SMS you can set the From or Sender field with whatever you have registered or purchased with Phonovation, either a Long Number, Short Code, or text based Sender. x-type: module x-displayName: Outbound SMS - name: send-message description: '' x-type: section x-displayName: Send a message - name: manage-scheduled-sms-messages description: '' x-type: section x-displayName: Manage Scheduled SMS Messages - name: confirm-conversion description: '' x-type: section x-displayName: Confirm conversion - name: inbound-sms description: > When an end user sends an SMS from their device to a Phone Number or Short Code they have sent an Inbound SMS. The Inbound SMS is routed to the Phonovation Platform and Phonovation in turn routes the SMS to its Customer who has purchased that Phone Number or Short Code. Inbound SMS, for historical reasons, are referred to as Mobile Originated (MO) SMS. x-type: module x-displayName: Inbound SMS - name: logs-and-status-reports description: > Status Reports tell you what happened to the SMS you sent, whether it was successfully delivered or failed to be delivered. They also provide timestamps, network information if available, and on SMS delivery failure, a status code indicating the reason. Status Reports can be pushed in real-time to a Customer's webhook or can be retrieved by an API call. Logs provide similar information to Status Reports but are available to query for 48hrs. x-type: module x-displayName: Logs and Status Reports - name: whatsapp description: > With 2 billion users, WhatsApp is the most used application worldwide. It enables you to reach more customers, sharing important and timely notifications, as well as provide real-time customer support. Phonovation is an official WhatsApp Business solution provider. Send and manage WhatsApp messages over Phonovation's WhatsApp API. To utilize WhatsApp in combination with other channels, check out [Messages API](https://www.phonovation.com/docs/api/platform/messages-api). [Learn more about WhatsApp channel and use cases](https://www.phonovation.com/docs/whatsapp). x-type: product x-displayName: WhatsApp - name: whatsapp-outbound-messages description: > When you send a WhatsApp message to a phone number belonging to an end user's device you are sending an outbound WhatsApp message. There are several types of WhatsApp messages: - Template message – use a pre-defined template to send text, images, videos, share location, documents, attach buttons, and configure SMS failover. - Free-form text or media – use it only when contacted by the end user within a certain timeframe to send text, images, audio, video, stickers, share location, or contacts. - Interactive messages – send a message that your end user can interact with, such as interactive buttons, lists, or product messages. x-type: module x-displayName: Outbound messages - name: whatsapp-template-message description: '' x-type: section x-displayName: Template Message - name: whatsapp-text-and-media-messages description: '' x-type: section x-displayName: Text and media messages - name: send-whatsapp-interactive-messages description: '' x-type: section x-displayName: Interactive messages - name: whatsapp-events description: '' x-type: section x-displayName: Events - name: whatsapp-inbound-messages description: > When the end user sends a WhatsApp from their device to a phone number, they have sent an inbound WhatsApp message. The inbound message is routed to the Phonovation Platform and Phonovation in turn routes the message to its customer who has registered the WhatsApp sender. Typical supporting features you’d use with inbound messages are: - Marking messages as read to communicate to the end user that you have read their message. - Downloading media and its metadata sent over by the end user. x-type: module x-displayName: Inbound messages - name: whatsapp-receive-inbound-message description: '' x-type: section x-displayName: Receive inbound message - name: whatsapp-get-inbound-media description: '' x-type: section x-displayName: Get inbound media - name: whatsapp-mark-message-as-read description: '' x-type: section x-displayName: Mark message as read - name: whatsapp-message-status-reports description: > Status Reports tell you what happened to the WhatsApp message you sent, whether it was successfully delivered or failed to be delivered, whether it’s been seen. Status Reports can be pushed in real time to a customer's webhook or can be retrieved by an API call. Logs provide similar information to Status Reports but are only available to query for 48hrs. There are a few reports you can set up for your WhatsApp messaging: - Delivery Reports - In case of a failure, you’ll receive a timestamp with a delivery failure message and a status code indicating the reason behind it. - Seen Reports – In case the message has been delivered successfully to the end user, this report will additionally inform you whether the message has been seen. - Payments - It provides all updates to your payment transaction in real time. It's also possible to fetch current state of the payment transaction in any time. x-type: module x-displayName: Message Status Reports - name: whatsapp-status-reports description: '' x-type: section x-displayName: Status Reports - name: whatsapp-payments description: '' x-type: section x-displayName: Payments - name: whatsapp-marketing-update description: '' x-type: section x-displayName: Marketing Update - name: whatsapp-service-management description: > As opposed to free-form messages, template messages can be sent and delivered at any time. Here, you can manage your templates, from template registration, retrieving template statuses, to deleting existing templates. With each WhatsApp message, you can send various types of media. Here, you can manage your media and configure additional feature enhancing their functionality. Moreover you can fetch quality and business info of your senders. x-type: module x-displayName: Service Management - name: whatsapp-template-management description: '' x-type: section x-displayName: Template Management - name: whatsapp-flow-management description: '' x-type: section x-displayName: Flow Management - name: whatsapp-media-management description: '' x-type: section x-displayName: Media Management - name: whatsapp-sender-management description: '' x-type: section x-displayName: Sender Management - name: whatsapp-bulk-sender-registration description: '' x-type: section x-displayName: Bulk Sender Registration - name: whatsapp-identity-management description: > Set up identity change, an add-on available for senders hosted by Phonovation. This is supported for interactive buttons, interactive lists, or an interactive product message. Identity change allows you to increase your security by preventing messages from being sent to unverified end users. Once enabled for a sender, you would receive notifications when an end user's WhatsApp account (MSISDN) has potentially been transferred to a different user. When a potential identity change has been detected, the outbound traffic towards that end user is blocked until you verify the user outside the channel and acknowledge the change. Contact your Account Executive for more information. x-type: module x-displayName: Identity Management - name: whatsapp-ad-conversions description: > The Conversions API for Business Messaging enables advertisers to consolidate web, app, physical store, and business messaging events into a single endpoint for Meta. With Phonovation, you can submit Purchase or LeadSubmitted conversion events for WhatsApp. x-type: module x-displayName: Ad Conversions - name: platform description: | Modular tools to scale and automate your business. x-type: category x-displayName: Platform - name: subscriptions-api description: > Subscriptions are a way to manage notifications sent to your webhooks by Phonovation. It is a useful feature if you want to narrow down the list of events to be notified about or specify different webhooks for different use cases. It will also allow you to set up authentication settings for your endpoint. If you want to use mutual TLS for the webhook that receives notification events from Phonovation, you can upload and manage a TLS certificate that Phonovation will use when connecting to your server. The certificate allows your server to verify that the request is really coming from Phonovation. For details, see [Create and Manage Certificates](https://www.phonovation.com/docs/cpaas-x/subscriptions-management/create-manage-subscriptions#create-and-manage-certificates). x-type: product x-displayName: Subscriptions Management - name: subscription description: '' x-type: section x-displayName: Subscription - name: profile description: '' x-type: section x-displayName: Profile - name: security description: '' x-type: section x-displayName: Security - name: certificate description: '' x-type: section x-displayName: Certificate paths: /subscriptions/1/subscription/{channel}: post: tags: - platform - subscriptions-api - subscription summary: Create subscription description: >- This method will create a new subscription. You can provide an ID of an existing profile, or submit a full definition of a profile and security settings if you want to create new ones. **Required scope:** Enable one of: `subscriptions:manage`. operationId: create-subscription parameters: - name: channel in: path description: Channel name. A separate subscription is needed for each channel. required: true style: simple explode: false schema: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SubscriptionChannel requestBody: content: application/json: schema: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SubscriptionRequest examples: Request example: summary: Request example value: subscriptionId: ABC-123-DEF name: Default group events: - DELIVERY criteria: - applicationId: production entityId: entity1 - applicationId: production entityId: entity2 - applicationId: test entityId: entity1 resources: - '1234' users: - user1 - user2 profile: profileId: NOTIF-32395 webhook: notifyUrl: https://www.example.com/pushme security: authId: NEWAUTH-9291 type: BASIC credentials: username: user1 password: password1 required: true responses: '201': description: Created. headers: Location: description: Resource location. style: simple explode: false schema: type: string content: application/json: schema: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlySubscriptionResponse '400': description: Bad request. content: application/json: schema: $ref: >- #/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException examples: Error responses: summary: Error responses description: Error responses value: requestError: serviceException: messageId: BAD_REQUEST text: Bad request validationErrors: field: - field must not be null Bad request: summary: Bad request value: requestError: serviceException: messageId: BAD_REQUEST text: Bad request '401': $ref: '#/components/responses/ApiException401' '403': $ref: '#/components/responses/ApiException403' '404': description: Not found. content: application/json: schema: $ref: >- #/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException examples: Error responses: summary: Error responses description: Error responses value: requestError: serviceException: messageId: NOT_FOUND text: Not found '429': description: Too many requests. content: application/json: schema: $ref: >- #/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException examples: Error responses: summary: Error responses description: Error responses value: requestError: serviceException: messageId: TOO_MANY_REQUESTS text: Too many requests '500': $ref: '#/components/responses/ApiException500' security: - APIKeyHeader: [] components: schemas: 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SubscriptionChannel: type: string enum: - AGENT_OS - APPLE_MESSAGES_FOR_BUSINESS - BLOCKLIST - CUSTOMER_ENGAGEMENT - EMAIL - FACEBOOK - KAKAO_ALIM - KAKAO_BRAND_MESSAGE - LINE - MMS - MOBILE_IDENTITY - MOBILE_PUSH - NUMBER_LOOKUP - OPEN_CHANNEL - RCS - REGISTRATION - SMS - VIBER - VOICE_VIDEO - WEB_PUSH - WHATSAPP - ZALO title: SubscriptionChannel 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SubscriptionRequest: oneOf: - $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.AgentOsSubscriptionRequest - $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.AppleMessagesForBusinessSubscriptionRequest - $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.BlocklistSubscriptionRequest - $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CustomerEngagementSubscriptionRequest - $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.EmailSubscriptionRequest - $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FacebookSubscriptionRequest - $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.KakaoAlimSubscriptionRequest - $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.KakaoBrandMessageSubscriptionRequest - $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.LineSubscriptionRequest - $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.MmsSubscriptionRequest - $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.MobileIdentitySubscriptionRequest - $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.MobilePushSubscriptionRequest - $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.NumberLookupSubscriptionRequest - $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.OpenChannelSubscriptionRequest - $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.RcsSubscriptionRequest - $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.RegistrationSubscriptionRequest - $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SmsSubscriptionRequest - $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ViberSubscriptionRequest - $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.VoiceVideoSubscriptionRequest - $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.WebPushSubscriptionRequest - $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.WhatsappSubscriptionRequest - $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ZaloSubscriptionRequest title: SubscriptionRequest 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlySubscriptionResponse: type: object description: Subscription group. properties: subscriptionId: type: string description: Subscription ID. profile: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileResponse title: Subscription d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException: type: object properties: requestError: $ref: '#/components/schemas/ApiRequestError' title: ApiException 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.AgentOsSubscriptionRequest: type: object description: Subscription group. properties: subscriptionId: type: string description: >- Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created. maxLength: 255 minLength: 1 name: type: string description: >- A human-readable description for your subscription, can be changed at a later point. maxLength: 255 minLength: 1 subscriptionGroupId: type: string description: >- Subscription group identifier. Subscriptions with different group IDs for the same event will each receive the event independently, enabling multi-webhook delivery. maxLength: 255 minLength: 0 events: type: array description: >- List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.phonovation.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.phonovation.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration). items: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleAgentOsEvents maxItems: 255 minItems: 0 criteria: type: array description: >- Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item. items: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair maxItems: 255 minItems: 0 resources: type: array description: >- List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. items: type: string description: >- List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. maxLength: 255 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' users: type: array description: List of users to match. You can provide usernames from your account. items: type: string description: >- List of users to match. You can provide usernames from your account. maxLength: 255 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' keywords: type: array description: >- List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. items: type: string description: >- List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. maxLength: 50 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' profile: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest required: - events - profile - subscriptionId title: AgentOS 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.AppleMessagesForBusinessSubscriptionRequest: type: object description: Subscription group. properties: subscriptionId: type: string description: >- Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created. maxLength: 255 minLength: 1 name: type: string description: >- A human-readable description for your subscription, can be changed at a later point. maxLength: 255 minLength: 1 subscriptionGroupId: type: string description: >- Subscription group identifier. Subscriptions with different group IDs for the same event will each receive the event independently, enabling multi-webhook delivery. maxLength: 255 minLength: 0 events: type: array description: >- List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.phonovation.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.phonovation.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration). items: oneOf: - $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleAppleMessagesForBusinessEvents - $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareAppleMessagesForBusinessEvents maxItems: 255 minItems: 0 criteria: type: array description: >- Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item. items: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair maxItems: 255 minItems: 0 resources: type: array description: >- List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. items: type: string description: >- List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. maxLength: 255 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' users: type: array description: List of users to match. You can provide usernames from your account. items: type: string description: >- List of users to match. You can provide usernames from your account. maxLength: 255 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' keywords: type: array description: >- List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. items: type: string description: >- List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. maxLength: 50 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' profile: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest required: - events - profile - subscriptionId title: Apple Messages For Business 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.BlocklistSubscriptionRequest: type: object description: Subscription group. properties: subscriptionId: type: string description: >- Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created. maxLength: 255 minLength: 1 name: type: string description: >- A human-readable description for your subscription, can be changed at a later point. maxLength: 255 minLength: 1 subscriptionGroupId: type: string description: >- Subscription group identifier. Subscriptions with different group IDs for the same event will each receive the event independently, enabling multi-webhook delivery. maxLength: 255 minLength: 0 events: type: array description: >- List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.phonovation.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.phonovation.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration). items: oneOf: - $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleBlocklistEvents - $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareBlocklistEvents maxItems: 255 minItems: 0 criteria: type: array description: >- Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item. items: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair maxItems: 255 minItems: 0 resources: type: array description: >- List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. items: type: string description: >- List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. maxLength: 255 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' users: type: array description: List of users to match. You can provide usernames from your account. items: type: string description: >- List of users to match. You can provide usernames from your account. maxLength: 255 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' keywords: type: array description: >- List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. items: type: string description: >- List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. maxLength: 50 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' profile: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest required: - events - profile - subscriptionId title: Blocklist 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CustomerEngagementSubscriptionRequest: type: object description: Subscription group. properties: subscriptionId: type: string description: >- Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created. maxLength: 255 minLength: 1 name: type: string description: >- A human-readable description for your subscription, can be changed at a later point. maxLength: 255 minLength: 1 subscriptionGroupId: type: string description: >- Subscription group identifier. Subscriptions with different group IDs for the same event will each receive the event independently, enabling multi-webhook delivery. maxLength: 255 minLength: 0 events: type: array description: >- List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.phonovation.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.phonovation.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration). items: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleCustomerEngagementEvents maxItems: 255 minItems: 0 criteria: type: array description: >- Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item. items: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair maxItems: 255 minItems: 0 resources: type: array description: >- List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. items: type: string description: >- List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. maxLength: 255 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' users: type: array description: List of users to match. You can provide usernames from your account. items: type: string description: >- List of users to match. You can provide usernames from your account. maxLength: 255 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' keywords: type: array description: >- List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. items: type: string description: >- List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. maxLength: 50 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' profile: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest required: - events - profile - subscriptionId title: Customer Engagement 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.EmailSubscriptionRequest: type: object description: Subscription group. properties: subscriptionId: type: string description: >- Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created. maxLength: 255 minLength: 1 name: type: string description: >- A human-readable description for your subscription, can be changed at a later point. maxLength: 255 minLength: 1 subscriptionGroupId: type: string description: >- Subscription group identifier. Subscriptions with different group IDs for the same event will each receive the event independently, enabling multi-webhook delivery. maxLength: 255 minLength: 0 events: type: array description: >- List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.phonovation.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.phonovation.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration). items: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleEmailEvents maxItems: 255 minItems: 0 criteria: type: array description: >- Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item. items: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair maxItems: 255 minItems: 0 resources: type: array description: >- List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. items: type: string description: >- List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. maxLength: 255 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' users: type: array description: List of users to match. You can provide usernames from your account. items: type: string description: >- List of users to match. You can provide usernames from your account. maxLength: 255 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' keywords: type: array description: >- List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. items: type: string description: >- List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. maxLength: 50 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' profile: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest required: - events - profile - subscriptionId title: Email 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FacebookSubscriptionRequest: type: object description: Subscription group. properties: subscriptionId: type: string description: >- Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created. maxLength: 255 minLength: 1 name: type: string description: >- A human-readable description for your subscription, can be changed at a later point. maxLength: 255 minLength: 1 subscriptionGroupId: type: string description: >- Subscription group identifier. Subscriptions with different group IDs for the same event will each receive the event independently, enabling multi-webhook delivery. maxLength: 255 minLength: 0 events: type: array description: >- List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.phonovation.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.phonovation.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration). items: oneOf: - $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleFacebookEvents - $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareFacebookEvents maxItems: 255 minItems: 0 criteria: type: array description: >- Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item. items: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair maxItems: 255 minItems: 0 resources: type: array description: >- List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. items: type: string description: >- List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. maxLength: 255 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' users: type: array description: List of users to match. You can provide usernames from your account. items: type: string description: >- List of users to match. You can provide usernames from your account. maxLength: 255 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' keywords: type: array description: >- List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. items: type: string description: >- List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. maxLength: 50 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' profile: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest required: - events - profile - subscriptionId title: Facebook 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.KakaoAlimSubscriptionRequest: type: object description: Subscription group. properties: subscriptionId: type: string description: >- Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created. maxLength: 255 minLength: 1 name: type: string description: >- A human-readable description for your subscription, can be changed at a later point. maxLength: 255 minLength: 1 subscriptionGroupId: type: string description: >- Subscription group identifier. Subscriptions with different group IDs for the same event will each receive the event independently, enabling multi-webhook delivery. maxLength: 255 minLength: 0 events: type: array description: >- List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.phonovation.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.phonovation.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration). items: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleKakaoAlimEvents maxItems: 255 minItems: 0 criteria: type: array description: >- Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item. items: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair maxItems: 255 minItems: 0 resources: type: array description: >- List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. items: type: string description: >- List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. maxLength: 255 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' users: type: array description: List of users to match. You can provide usernames from your account. items: type: string description: >- List of users to match. You can provide usernames from your account. maxLength: 255 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' keywords: type: array description: >- List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. items: type: string description: >- List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. maxLength: 50 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' profile: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest required: - events - profile - subscriptionId title: Kakao Alim 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.KakaoBrandMessageSubscriptionRequest: type: object description: Subscription group. properties: subscriptionId: type: string description: >- Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created. maxLength: 255 minLength: 1 name: type: string description: >- A human-readable description for your subscription, can be changed at a later point. maxLength: 255 minLength: 1 subscriptionGroupId: type: string description: >- Subscription group identifier. Subscriptions with different group IDs for the same event will each receive the event independently, enabling multi-webhook delivery. maxLength: 255 minLength: 0 events: type: array description: >- List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.phonovation.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.phonovation.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration). items: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleKakaoBrandMessageEvents maxItems: 255 minItems: 0 criteria: type: array description: >- Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item. items: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair maxItems: 255 minItems: 0 resources: type: array description: >- List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. items: type: string description: >- List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. maxLength: 255 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' users: type: array description: List of users to match. You can provide usernames from your account. items: type: string description: >- List of users to match. You can provide usernames from your account. maxLength: 255 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' keywords: type: array description: >- List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. items: type: string description: >- List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. maxLength: 50 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' profile: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest required: - events - profile - subscriptionId title: Kakao Brand Message 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.LineSubscriptionRequest: type: object description: Subscription group. properties: subscriptionId: type: string description: >- Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created. maxLength: 255 minLength: 1 name: type: string description: >- A human-readable description for your subscription, can be changed at a later point. maxLength: 255 minLength: 1 subscriptionGroupId: type: string description: >- Subscription group identifier. Subscriptions with different group IDs for the same event will each receive the event independently, enabling multi-webhook delivery. maxLength: 255 minLength: 0 events: type: array description: >- List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.phonovation.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.phonovation.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration). items: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleLineEvents maxItems: 255 minItems: 0 criteria: type: array description: >- Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item. items: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair maxItems: 255 minItems: 0 resources: type: array description: >- List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. items: type: string description: >- List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. maxLength: 255 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' users: type: array description: List of users to match. You can provide usernames from your account. items: type: string description: >- List of users to match. You can provide usernames from your account. maxLength: 255 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' keywords: type: array description: >- List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. items: type: string description: >- List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. maxLength: 50 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' profile: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest required: - events - profile - subscriptionId title: Line 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.MmsSubscriptionRequest: type: object description: Subscription group. properties: subscriptionId: type: string description: >- Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created. maxLength: 255 minLength: 1 name: type: string description: >- A human-readable description for your subscription, can be changed at a later point. maxLength: 255 minLength: 1 subscriptionGroupId: type: string description: >- Subscription group identifier. Subscriptions with different group IDs for the same event will each receive the event independently, enabling multi-webhook delivery. maxLength: 255 minLength: 0 events: type: array description: >- List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.phonovation.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.phonovation.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration). items: oneOf: - $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleMmsEvents - $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareMmsEvents maxItems: 255 minItems: 0 criteria: type: array description: >- Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item. items: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair maxItems: 255 minItems: 0 resources: type: array description: >- List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. items: type: string description: >- List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. maxLength: 255 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' users: type: array description: List of users to match. You can provide usernames from your account. items: type: string description: >- List of users to match. You can provide usernames from your account. maxLength: 255 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' keywords: type: array description: >- List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. items: type: string description: >- List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. maxLength: 50 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' profile: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest required: - events - profile - subscriptionId title: MMS 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.MobileIdentitySubscriptionRequest: type: object description: Subscription group. properties: subscriptionId: type: string description: >- Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created. maxLength: 255 minLength: 1 name: type: string description: >- A human-readable description for your subscription, can be changed at a later point. maxLength: 255 minLength: 1 subscriptionGroupId: type: string description: >- Subscription group identifier. Subscriptions with different group IDs for the same event will each receive the event independently, enabling multi-webhook delivery. maxLength: 255 minLength: 0 events: type: array description: >- List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.phonovation.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.phonovation.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration). items: oneOf: - $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleMobileIdentityEvents - $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareMobileIdentityEvents maxItems: 255 minItems: 0 criteria: type: array description: >- Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item. items: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair maxItems: 255 minItems: 0 resources: type: array description: >- List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. items: type: string description: >- List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. maxLength: 255 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' users: type: array description: List of users to match. You can provide usernames from your account. items: type: string description: >- List of users to match. You can provide usernames from your account. maxLength: 255 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' keywords: type: array description: >- List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. items: type: string description: >- List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. maxLength: 50 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' profile: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest required: - events - profile - subscriptionId title: Mobile Identity 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.MobilePushSubscriptionRequest: type: object description: Subscription group. properties: subscriptionId: type: string description: >- Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created. maxLength: 255 minLength: 1 name: type: string description: >- A human-readable description for your subscription, can be changed at a later point. maxLength: 255 minLength: 1 subscriptionGroupId: type: string description: >- Subscription group identifier. Subscriptions with different group IDs for the same event will each receive the event independently, enabling multi-webhook delivery. maxLength: 255 minLength: 0 events: type: array description: >- List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.phonovation.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.phonovation.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration). items: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleMobilePushEvents maxItems: 255 minItems: 0 criteria: type: array description: >- Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item. items: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair maxItems: 255 minItems: 0 resources: type: array description: >- List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. items: type: string description: >- List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. maxLength: 255 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' users: type: array description: List of users to match. You can provide usernames from your account. items: type: string description: >- List of users to match. You can provide usernames from your account. maxLength: 255 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' keywords: type: array description: >- List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. items: type: string description: >- List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. maxLength: 50 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' profile: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest required: - events - profile - subscriptionId title: Mobile Push 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.NumberLookupSubscriptionRequest: type: object description: Subscription group. properties: subscriptionId: type: string description: >- Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created. maxLength: 255 minLength: 1 name: type: string description: >- A human-readable description for your subscription, can be changed at a later point. maxLength: 255 minLength: 1 subscriptionGroupId: type: string description: >- Subscription group identifier. Subscriptions with different group IDs for the same event will each receive the event independently, enabling multi-webhook delivery. maxLength: 255 minLength: 0 events: type: array description: >- List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.phonovation.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.phonovation.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration). items: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleNumberLookupEvents maxItems: 255 minItems: 0 criteria: type: array description: >- Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item. items: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair maxItems: 255 minItems: 0 resources: type: array description: >- List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. items: type: string description: >- List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. maxLength: 255 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' users: type: array description: List of users to match. You can provide usernames from your account. items: type: string description: >- List of users to match. You can provide usernames from your account. maxLength: 255 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' keywords: type: array description: >- List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. items: type: string description: >- List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. maxLength: 50 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' profile: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest required: - events - profile - subscriptionId title: Number Lookup 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.OpenChannelSubscriptionRequest: type: object description: Subscription group. properties: subscriptionId: type: string description: >- Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created. maxLength: 255 minLength: 1 name: type: string description: >- A human-readable description for your subscription, can be changed at a later point. maxLength: 255 minLength: 1 subscriptionGroupId: type: string description: >- Subscription group identifier. Subscriptions with different group IDs for the same event will each receive the event independently, enabling multi-webhook delivery. maxLength: 255 minLength: 0 events: type: array description: >- List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.phonovation.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.phonovation.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration). items: oneOf: - $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleOpenChannelEvents - $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareOpenChannelEvents maxItems: 255 minItems: 0 criteria: type: array description: >- Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item. items: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair maxItems: 255 minItems: 0 resources: type: array description: >- List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. items: type: string description: >- List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. maxLength: 255 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' users: type: array description: List of users to match. You can provide usernames from your account. items: type: string description: >- List of users to match. You can provide usernames from your account. maxLength: 255 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' keywords: type: array description: >- List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. items: type: string description: >- List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. maxLength: 50 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' profile: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest required: - events - profile - subscriptionId title: Open Channel 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.RcsSubscriptionRequest: type: object description: Subscription group. properties: subscriptionId: type: string description: >- Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created. maxLength: 255 minLength: 1 name: type: string description: >- A human-readable description for your subscription, can be changed at a later point. maxLength: 255 minLength: 1 subscriptionGroupId: type: string description: >- Subscription group identifier. Subscriptions with different group IDs for the same event will each receive the event independently, enabling multi-webhook delivery. maxLength: 255 minLength: 0 events: type: array description: >- List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.phonovation.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.phonovation.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration). items: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleRcsEvents maxItems: 255 minItems: 0 criteria: type: array description: >- Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item. items: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair maxItems: 255 minItems: 0 resources: type: array description: >- List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. items: type: string description: >- List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. maxLength: 255 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' users: type: array description: List of users to match. You can provide usernames from your account. items: type: string description: >- List of users to match. You can provide usernames from your account. maxLength: 255 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' keywords: type: array description: >- List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. items: type: string description: >- List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. maxLength: 50 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' profile: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest required: - events - profile - subscriptionId title: RCS 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.RegistrationSubscriptionRequest: type: object description: Subscription group. properties: subscriptionId: type: string description: >- Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created. maxLength: 255 minLength: 1 name: type: string description: >- A human-readable description for your subscription, can be changed at a later point. maxLength: 255 minLength: 1 subscriptionGroupId: type: string description: >- Subscription group identifier. Subscriptions with different group IDs for the same event will each receive the event independently, enabling multi-webhook delivery. maxLength: 255 minLength: 0 events: type: array description: >- List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.phonovation.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.phonovation.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration). items: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleRegistrationEvents maxItems: 255 minItems: 0 criteria: type: array description: >- Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item. items: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair maxItems: 255 minItems: 0 resources: type: array description: >- List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. items: type: string description: >- List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. maxLength: 255 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' users: type: array description: List of users to match. You can provide usernames from your account. items: type: string description: >- List of users to match. You can provide usernames from your account. maxLength: 255 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' keywords: type: array description: >- List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. items: type: string description: >- List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. maxLength: 50 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' profile: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest required: - events - profile - subscriptionId title: Registration 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SmsSubscriptionRequest: type: object description: Subscription group. properties: subscriptionId: type: string description: >- Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created. maxLength: 255 minLength: 1 name: type: string description: >- A human-readable description for your subscription, can be changed at a later point. maxLength: 255 minLength: 1 subscriptionGroupId: type: string description: >- Subscription group identifier. Subscriptions with different group IDs for the same event will each receive the event independently, enabling multi-webhook delivery. maxLength: 255 minLength: 0 events: type: array description: >- List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.phonovation.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.phonovation.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration). items: oneOf: - $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleSmsEvents - $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareSmsEvents maxItems: 255 minItems: 0 criteria: type: array description: >- Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item. items: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair maxItems: 255 minItems: 0 resources: type: array description: >- List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. items: type: string description: >- List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. maxLength: 255 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' users: type: array description: List of users to match. You can provide usernames from your account. items: type: string description: >- List of users to match. You can provide usernames from your account. maxLength: 255 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' keywords: type: array description: >- List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. items: type: string description: >- List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. maxLength: 50 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' profile: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest required: - events - profile - subscriptionId title: SMS 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ViberSubscriptionRequest: type: object description: Subscription group. properties: subscriptionId: type: string description: >- Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created. maxLength: 255 minLength: 1 name: type: string description: >- A human-readable description for your subscription, can be changed at a later point. maxLength: 255 minLength: 1 subscriptionGroupId: type: string description: >- Subscription group identifier. Subscriptions with different group IDs for the same event will each receive the event independently, enabling multi-webhook delivery. maxLength: 255 minLength: 0 events: type: array description: >- List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.phonovation.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.phonovation.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration). items: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleViberEvents maxItems: 255 minItems: 0 criteria: type: array description: >- Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item. items: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair maxItems: 255 minItems: 0 resources: type: array description: >- List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. items: type: string description: >- List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. maxLength: 255 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' users: type: array description: List of users to match. You can provide usernames from your account. items: type: string description: >- List of users to match. You can provide usernames from your account. maxLength: 255 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' keywords: type: array description: >- List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. items: type: string description: >- List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. maxLength: 50 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' profile: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest required: - events - profile - subscriptionId title: Viber 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.VoiceVideoSubscriptionRequest: type: object description: Subscription group. properties: subscriptionId: type: string description: >- Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created. maxLength: 255 minLength: 1 name: type: string description: >- A human-readable description for your subscription, can be changed at a later point. maxLength: 255 minLength: 1 subscriptionGroupId: type: string description: >- Subscription group identifier. Subscriptions with different group IDs for the same event will each receive the event independently, enabling multi-webhook delivery. maxLength: 255 minLength: 0 events: type: array description: >- List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.phonovation.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.phonovation.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration). items: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleVoiceVideoEvents maxItems: 255 minItems: 0 criteria: type: array description: >- Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item. items: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair maxItems: 255 minItems: 0 resources: type: array description: >- List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. items: type: string description: >- List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. maxLength: 255 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' users: type: array description: List of users to match. You can provide usernames from your account. items: type: string description: >- List of users to match. You can provide usernames from your account. maxLength: 255 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' keywords: type: array description: >- List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. items: type: string description: >- List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. maxLength: 50 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' profile: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest required: - events - profile - subscriptionId title: Voice and Video 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.WebPushSubscriptionRequest: type: object description: Subscription group. properties: subscriptionId: type: string description: >- Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created. maxLength: 255 minLength: 1 name: type: string description: >- A human-readable description for your subscription, can be changed at a later point. maxLength: 255 minLength: 1 subscriptionGroupId: type: string description: >- Subscription group identifier. Subscriptions with different group IDs for the same event will each receive the event independently, enabling multi-webhook delivery. maxLength: 255 minLength: 0 events: type: array description: >- List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.phonovation.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.phonovation.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration). items: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleWebPushEvents maxItems: 255 minItems: 0 criteria: type: array description: >- Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item. items: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair maxItems: 255 minItems: 0 resources: type: array description: >- List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. items: type: string description: >- List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. maxLength: 255 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' users: type: array description: List of users to match. You can provide usernames from your account. items: type: string description: >- List of users to match. You can provide usernames from your account. maxLength: 255 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' keywords: type: array description: >- List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. items: type: string description: >- List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. maxLength: 50 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' profile: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest required: - events - profile - subscriptionId title: Web Push 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.WhatsappSubscriptionRequest: type: object description: Subscription group. properties: subscriptionId: type: string description: >- Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created. maxLength: 255 minLength: 1 name: type: string description: >- A human-readable description for your subscription, can be changed at a later point. maxLength: 255 minLength: 1 subscriptionGroupId: type: string description: >- Subscription group identifier. Subscriptions with different group IDs for the same event will each receive the event independently, enabling multi-webhook delivery. maxLength: 255 minLength: 0 events: type: array description: >- List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.phonovation.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.phonovation.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration). items: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleWhatsappEvents maxItems: 255 minItems: 0 criteria: type: array description: >- Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item. items: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair maxItems: 255 minItems: 0 resources: type: array description: >- List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. items: type: string description: >- List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. maxLength: 255 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' users: type: array description: List of users to match. You can provide usernames from your account. items: type: string description: >- List of users to match. You can provide usernames from your account. maxLength: 255 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' keywords: type: array description: >- List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. items: type: string description: >- List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. maxLength: 50 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' profile: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest required: - events - profile - subscriptionId title: Whatsapp 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ZaloSubscriptionRequest: type: object description: Subscription group. properties: subscriptionId: type: string description: >- Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created. maxLength: 255 minLength: 1 name: type: string description: >- A human-readable description for your subscription, can be changed at a later point. maxLength: 255 minLength: 1 subscriptionGroupId: type: string description: >- Subscription group identifier. Subscriptions with different group IDs for the same event will each receive the event independently, enabling multi-webhook delivery. maxLength: 255 minLength: 0 events: type: array description: >- List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.phonovation.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.phonovation.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration). items: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleZaloEvents maxItems: 255 minItems: 0 criteria: type: array description: >- Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item. items: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair maxItems: 255 minItems: 0 resources: type: array description: >- List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. items: type: string description: >- List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit. maxLength: 255 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' users: type: array description: List of users to match. You can provide usernames from your account. items: type: string description: >- List of users to match. You can provide usernames from your account. maxLength: 255 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' keywords: type: array description: >- List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. items: type: string description: >- List of keywords to match. Route inbound messages by their first word. A customer texting STOP or ORDER to your number triggers only the subscriptions matching that keyword. maxLength: 50 minLength: 0 x-is-early-access: 'true' maxItems: 255 minItems: 0 x-is-early-access: 'true' profile: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest required: - events - profile - subscriptionId title: Zalo 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileResponse: type: object description: Notification profile. properties: profileId: type: string description: Unique profile ID. security: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlySecurityResponse title: Profile ApiRequestError: type: object properties: serviceException: $ref: '#/components/schemas/ApiRequestErrorDetails' title: ApiRequestError ApiException: type: object properties: requestError: $ref: '#/components/schemas/ApiRequestError' title: ApiException 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleAgentOsEvents: type: string enum: - CONVERSATION_AGENT_STATUS_UPDATED - CONVERSATION_ASSIGNMENT_UPDATED - CONVERSATION_CREATED - CONVERSATION_CUSTOMER_UPDATED - CONVERSATION_FORM_FIELD_UPDATED - CONVERSATION_FORM_UPDATED - CONVERSATION_MESSAGE_DELETED - CONVERSATION_MESSAGE_RECEIVED - CONVERSATION_MESSAGE_SENT - CONVERSATION_MESSAGE_UPDATED - CONVERSATION_NOTE_ADDED - CONVERSATION_NOTE_REMOVED - CONVERSATION_NOTE_UPDATED - CONVERSATION_PRIORITY_UPDATED - CONVERSATION_QUEUE_UPDATED - CONVERSATION_SLA_POLICY_UPDATED - CONVERSATION_STATUS_UPDATED - CONVERSATION_SUMMARY_UPDATED - CONVERSATION_TAG_ADDED - CONVERSATION_TAG_REMOVED - CONVERSATION_TOPIC_UPDATED - MOBILE_APP_APP_LAUNCH - MOBILE_APP_DEPERSONALIZE - MOBILE_APP_INSTALL - MOBILE_APP_PERSONALIZE - MOBILE_APP_UNINSTALL - PEOPLE_CUSTOM_AND_TEMPLATE_EVENTS - PERSON_ATTRIBUTE_CHANGED - PERSON_CONTACT_INFORMATION_CREATED - PERSON_CONTACT_INFORMATION_DELETED - PERSON_CONTACT_INFORMATION_UPDATED - PERSON_CREATED - PERSON_DELETED - PERSON_MERGED - PERSON_TAG_ADDED - PERSON_TAG_DELETED - WEB_SDK_PAGE_VIEW - WEB_SDK_SESSION_ENDED - WEB_SDK_SESSION_STARTED title: Event 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair: type: object description: >- Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item. properties: applicationId: type: string description: >- CPaaS X property identifying an application, an use case or an environment on your system. Should only be set if you are using CPaaS X Applications with your traffic. maxLength: 255 minLength: 0 entityId: type: string description: >- CPaaS X property identifying an unique actor on your system. Should only be set if you are using CPaaS X Applications with your traffic. maxLength: 255 minLength: 0 callsConfigurationId: type: string description: >- CPaaS X calls configuration identifier. Should only be set if you are using CPaaS X Applications with your traffic. maxLength: 255 minLength: 0 title: ApplicationEntityPair 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest: type: object description: >- Notification profile object holding the settings for your webhook URL and a reference to security settings. You can provide full definition of a notification profile and security settings if you want to create new items, or provide an ID of an existing profile to reuse it. If you want to reuse an existing profile, do not provide any other notification profile and security settings properties. properties: profileId: type: string description: >- ID of a notification profile. This identifier will be used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once an item is created. maxLength: 255 minLength: 1 webhook: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.Webhook security: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SecurityRequest clientCertificateId: type: string description: Client certificate ID. maxLength: 255 minLength: 0 pattern: ^[a-zA-Z0-9._-]+$ maxBucketSize: type: integer format: int32 description: >- Specifies a maximum number of messages to be sent within a single request. maximum: 2000 minimum: 1 windowSize: type: integer format: int32 description: >- A maximum number of concurrent connections (active requests) per client. maximum: 10000 minimum: 20 connectTimeout: type: integer format: int32 description: >- Time in milliseconds sender system waits for connection acknowledgement until the connection is closed. maximum: 30000 minimum: 300 readTimeout: type: integer format: int32 description: >- A maximum period of inactivity in milliseconds between two consecutive data packets. maximum: 90000 minimum: 1000 enabledSSLProtocols: type: array description: >- Specifies which security protocols should be used to send a HTTP request. Multiple options can be used. enum: - TLSv1.2 - TLSv1.3 items: type: string description: >- Specifies which security protocols should be used to send a HTTP request. Multiple options can be used. enum: - TLSv1.2 - TLSv1.3 uniqueItems: true headers: type: object additionalProperties: type: string description: >- Set of key:value pairs that will be sent in a HTTP request as headers.Note: 'Authorization' header (if configured here for any reason) can be overridden with one from security config. responseRegex: type: string description: Response regex. responseBodyRegex: type: string description: Response body regex. rateLimit: type: integer format: int32 description: Limits the number of requests per second. maximum: 5000 minimum: 1 required: - profileId title: Profile 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleAppleMessagesForBusinessEvents: type: string enum: - DELIVERY - INBOUND_MESSAGE - TYPING_INDICATOR title: Event 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareAppleMessagesForBusinessEvents: type: object properties: event: type: string enum: - DELIVERY - INBOUND_MESSAGE - TYPING_INDICATOR format: type: string description: >- Format which you want to assign to the event. For more information about available formats and their payload, check our [Event Formats](https://www.phonovation.com/docs/cpaas-x/subscriptions-management/event-formats) page. required: - event - format title: Event with format 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleBlocklistEvents: type: string enum: - BLOCK - UNBLOCK title: Event 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareBlocklistEvents: type: object properties: event: type: string enum: - BLOCK - UNBLOCK format: type: string description: >- Format which you want to assign to the event. For more information about available formats and their payload, check our [Event Formats](https://www.phonovation.com/docs/cpaas-x/subscriptions-management/event-formats) page. required: - event - format title: Event with format 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleCustomerEngagementEvents: type: string enum: - CONVERSATION_AGENT_STATUS_UPDATED - CONVERSATION_ASSIGNMENT_UPDATED - CONVERSATION_CREATED - CONVERSATION_CUSTOMER_UPDATED - CONVERSATION_FORM_FIELD_UPDATED - CONVERSATION_FORM_UPDATED - CONVERSATION_MESSAGE_DELETED - CONVERSATION_MESSAGE_RECEIVED - CONVERSATION_MESSAGE_SENT - CONVERSATION_MESSAGE_UPDATED - CONVERSATION_NOTE_ADDED - CONVERSATION_NOTE_REMOVED - CONVERSATION_NOTE_UPDATED - CONVERSATION_PRIORITY_UPDATED - CONVERSATION_QUEUE_UPDATED - CONVERSATION_SLA_POLICY_UPDATED - CONVERSATION_STATUS_UPDATED - CONVERSATION_SUMMARY_UPDATED - CONVERSATION_TAG_ADDED - CONVERSATION_TAG_REMOVED - CONVERSATION_TOPIC_UPDATED - MOBILE_APP_APP_LAUNCH - MOBILE_APP_DEPERSONALIZE - MOBILE_APP_INSTALL - MOBILE_APP_PERSONALIZE - MOBILE_APP_UNINSTALL - PEOPLE_CUSTOM_AND_TEMPLATE_EVENTS - PERSON_ATTRIBUTE_CHANGED - PERSON_CONTACT_INFORMATION_CREATED - PERSON_CONTACT_INFORMATION_DELETED - PERSON_CONTACT_INFORMATION_UPDATED - PERSON_CREATED - PERSON_DELETED - PERSON_MERGED - PERSON_TAG_ADDED - PERSON_TAG_DELETED - WEB_SDK_PAGE_VIEW - WEB_SDK_SESSION_ENDED - WEB_SDK_SESSION_STARTED title: Event 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleEmailEvents: type: string enum: - ARTIFICIAL_CLICK - CLICK - COMPLAINT - DELIVERY - HIGH_BOUNCE_RATE_BLOCKED - HIGH_BOUNCE_RATE_WARNING - LATE_BOUNCE - OPEN - UNSUBSCRIBE title: Event 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleFacebookEvents: type: string enum: - AUDIENCE_UPLOAD_STATUS - CLICK - CONSENT_UPDATE - DELIVERY - INBOUND_MESSAGE - SEEN title: Event 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareFacebookEvents: type: object properties: event: type: string enum: - AUDIENCE_UPLOAD_STATUS - CLICK - CONSENT_UPDATE - DELIVERY - INBOUND_MESSAGE - SEEN format: type: string description: >- Format which you want to assign to the event. For more information about available formats and their payload, check our [Event Formats](https://www.phonovation.com/docs/cpaas-x/subscriptions-management/event-formats) page. required: - event - format title: Event with format 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleKakaoAlimEvents: type: string enum: - DELIVERY title: Event 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleKakaoBrandMessageEvents: type: string enum: - CLICK - DELIVERY title: Event 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleLineEvents: type: string enum: - DELIVERY - INBOUND_MESSAGE title: Event 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleMmsEvents: type: string enum: - CLICK - DELIVERY - INBOUND_MESSAGE title: Event 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareMmsEvents: type: object properties: event: type: string enum: - CLICK - DELIVERY - INBOUND_MESSAGE format: type: string description: >- Format which you want to assign to the event. For more information about available formats and their payload, check our [Event Formats](https://www.phonovation.com/docs/cpaas-x/subscriptions-management/event-formats) page. required: - event - format title: Event with format 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleMobileIdentityEvents: type: string enum: - SILENT_VERIFICATION title: Event 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareMobileIdentityEvents: type: object properties: event: type: string enum: - SILENT_VERIFICATION format: type: string description: >- Format which you want to assign to the event. For more information about available formats and their payload, check our [Event Formats](https://www.phonovation.com/docs/cpaas-x/subscriptions-management/event-formats) page. required: - event - format title: Event with format 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleMobilePushEvents: type: string enum: - DELIVERY - SEEN - SENT title: Event 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleNumberLookupEvents: type: string enum: - NUMBER_LOOKUP title: Event 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleOpenChannelEvents: type: string enum: - DELIVERY title: Event 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareOpenChannelEvents: type: object properties: event: type: string enum: - DELIVERY format: type: string description: >- Format which you want to assign to the event. For more information about available formats and their payload, check our [Event Formats](https://www.phonovation.com/docs/cpaas-x/subscriptions-management/event-formats) page. required: - event - format title: Event with format 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleRcsEvents: type: string enum: - CAP_CHECK - CLICK - CONVERSATION_STARTED - DELIVERY - INBOUND_MESSAGE - PROVIDER_UPDATE - SEEN - SENDER_LAUNCH_UPDATE - SENDER_UPDATE - SUGGESTION - TEMPLATE_UPDATE - TEST_NUMBER_UPDATE - TYPING_INDICATOR title: Event 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleRegistrationEvents: type: string enum: - AI_CAMPAIGN_BUILDER - AI_CAMPAIGN_FEEDBACK - BRAND_AUTH_UPDATE - BRAND_STATUS_UPDATE - BRAND_VET_UPDATE - CAMPAIGN_NETWORK_STATUS_UPDATE - CAMPAIGN_STATUS_UPDATE - RESOURCE_REQUEST_FOC_DATE_CHANGE - RESOURCE_REQUEST_REMINDER - RESOURCE_REQUEST_STATUS_UPDATE title: Event 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleSmsEvents: type: string enum: - CLICK - DELIVERY - INBOUND_MESSAGE title: Event 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareSmsEvents: type: object properties: event: type: string enum: - CLICK - DELIVERY - INBOUND_MESSAGE format: type: string description: >- Format which you want to assign to the event. For more information about available formats and their payload, check our [Event Formats](https://www.phonovation.com/docs/cpaas-x/subscriptions-management/event-formats) page. required: - event - format title: Event with format 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleViberEvents: type: string enum: - CLICK - CONSENT_UPDATE - DELIVERY - INBOUND_MESSAGE - SEEN - TEMPLATE_UPDATE title: Event 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleVoiceVideoEvents: type: string enum: - APPLICATION_TRANSFER_FAILED - APPLICATION_TRANSFER_FINISHED - APPLICATION_TRANSFER_REQUESTED - BULK_CALL_STATUS - CALL_DISCONNECTED - CALL_ESTABLISHED - CALL_FAILED - CALL_FINISHED - CALL_MEDIA_CHANGED - CALL_PRE_ESTABLISHED - CALL_RECEIVED - CALL_RECONNECTED - CALL_RECORDING_DELETED - CALL_RECORDING_FAILED - CALL_RECORDING_READY - CALL_RECORDING_STARTED - CALL_RECORDING_STOPPED - CALL_RINGING - CALL_STARTED - CONFERENCE_COMPOSITION_FAILED - CONFERENCE_COMPOSITION_FINISHED - CONFERENCE_CREATED - CONFERENCE_FINISHED - CONFERENCE_RECORDING_DELETED - CONFERENCE_RECORDING_FAILED - CONFERENCE_RECORDING_READY - CONFERENCE_RECORDING_STARTED - CONFERENCE_RECORDING_STOPPED - DELIVERY - DIALOG_COMPOSITION_FAILED - DIALOG_COMPOSITION_FINISHED - DIALOG_CREATED - DIALOG_ESTABLISHED - DIALOG_FAILED - DIALOG_FINISHED - DIALOG_RECORDING_DELETED - DIALOG_RECORDING_FAILED - DIALOG_RECORDING_READY - DIALOG_RECORDING_STARTED - DIALOG_RECORDING_STOPPED - DIALOG_TRANSFER_FAILED - DIALOG_TRANSFER_FINISHED - DIALOG_TRANSFER_REQUESTED - DTMF_CAPTURED - ERROR - MACHINE_DETECTION_FAILED - MACHINE_DETECTION_FINISHED - MACHINE_MESSAGE_DETECTION_FAILED - MACHINE_MESSAGE_DETECTION_FINISHED - MEDIA_STREAM_FAILED - MEDIA_STREAM_FINISHED - MEDIA_STREAM_STARTED - MISSED_CALL - NUMBER_MASKING - PARTICIPANT_JOINED - PARTICIPANT_JOINING - PARTICIPANT_JOIN_FAILED - PARTICIPANT_MEDIA_CHANGED - PARTICIPANT_RECORDING_FAILED - PARTICIPANT_REMOVED - PARTICIPANT_ROLE_CHANGED - PARTICIPANT_ROLE_CHANGE_FAILED - PARTICIPANT_STARTED_TALKING - PARTICIPANT_STOPPED_TALKING - PLAY_FINISHED - SAY_FINISHED - SILENT_VERIFICATION_DELIVERY - SPEECH_CAPTURED - TRANSCRIPTION title: Event 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleWebPushEvents: type: string enum: - DELIVERY title: Event 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleWhatsappEvents: type: string enum: - ACCOUNT_REGISTRATION - ACCOUNT_UPDATE_NOTIFICATION - BILLING - BUSINESS_APP_CONTACT_SYNC - BUSINESS_APP_MESSAGE_ECHO - BUSINESS_APP_MESSAGE_HISTORY - CLICK - DELIVERY - IDENTITY_CHANGE - INBOUND_MESSAGE - MARKETING_SUBSCRIPTION_UPDATE - PAYMENT_STATUS - SEEN - TEMPLATE_UPDATE title: Event 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleZaloEvents: type: string enum: - CLICK - DELIVERY - INBOUND_MESSAGE - TEMPLATE_UPDATE title: Event 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlySecurityResponse: type: object description: Security configuration. properties: authId: type: string description: Unique authorization ID. title: Security ApiRequestErrorDetails: type: object properties: messageId: type: string description: Identifier of the error. text: type: string description: Detailed error description. validationErrors: type: object additionalProperties: type: array items: type: string description: Validation errors. description: Validation errors. title: ApiRequestErrorDetails 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.Webhook: type: object description: Webhook configuration. properties: contentType: type: string maxLength: 255 minLength: 0 notifyUrl: type: string description: Your webhook URL, where the notifications will be sent to. maxLength: 512 minLength: 0 required: - notifyUrl title: Webhook 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SecurityRequest: type: object description: >- Security settings object holding the authentication settings necessary to access your webhook. Should only be provided if you are creating a new profile and settings; otherwise it will be ignored. properties: authId: type: string description: >- Unique security setting ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once an item is created. maxLength: 255 minLength: 1 type: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CredentialsType credentials: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CredentialsPayload required: - authId title: Security 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CredentialsType: type: string description: Credentials type. enum: - BASIC - HMAC - OAUTH - CUSTOM title: CredentialsType 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CredentialsPayload: type: object description: Webhook security credentials. oneOf: - $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.BasicCredentialsPayload - $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.HmacCredentialsPayload - $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.OauthCredentialsPayload title: Credentials 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.BasicCredentialsPayload: type: object description: Basic credentials. properties: username: type: string description: Username. maxLength: 255 minLength: 1 password: type: string description: Password. maxLength: 255 minLength: 1 required: - password - username title: BasicCredentials 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.HmacCredentialsPayload: type: object description: HMAC credentials. properties: secretKey: type: string description: Secret key. maxLength: 255 minLength: 1 algorithm: $ref: >- #/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.HmacAlgorithm required: - algorithm - secretKey title: HmacCredentials 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.OauthCredentialsPayload: type: object description: OAuth credentials. properties: tokenUrl: type: string description: Token URL. maxLength: 255 minLength: 1 clientId: type: string description: Client ID. maxLength: 255 minLength: 0 clientSecret: type: string description: Client secret. maxLength: 255 minLength: 0 grantType: type: string description: Grant type. maxLength: 255 minLength: 1 scope: type: string description: Scope. maxLength: 255 minLength: 0 username: type: string description: Username. maxLength: 255 minLength: 0 password: type: string description: Password. maxLength: 255 minLength: 0 resource: type: string description: Resource. maxLength: 255 minLength: 0 refreshToken: type: string description: Refresh token. maxLength: 255 minLength: 0 headers: type: object additionalProperties: type: string description: >- Set of key:value pairs that will be sent in a HTTP request as headers. required: - grantType - tokenUrl title: OauthCredentials 6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.HmacAlgorithm: type: string description: HMAC algorithm. enum: - HMAC_MD5 - HMAC_SHA_1 - HMAC_SHA_224 - HMAC_SHA_256 - HMAC_SHA_384 - HMAC_SHA_512 title: HmacAlgorithm responses: ApiException401: description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ApiException' example: requestError: serviceException: messageId: UNAUTHORIZED text: Unauthorized application/xml: schema: $ref: '#/components/schemas/ApiException' example: | UNAUTHORIZED Unauthorized ApiException403: description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ApiException' example: requestError: serviceException: messageId: FORBIDDEN text: Forbidden application/xml: schema: $ref: '#/components/schemas/ApiException' example: | FORBIDDEN Forbidden ApiException500: description: Internal Server Error content: application/json: schema: $ref: '#/components/schemas/ApiException' example: requestError: serviceException: messageId: GENERAL_ERROR text: Something went wrong. Please contact support. application/xml: schema: $ref: '#/components/schemas/ApiException' example: | GENERAL_ERROR Something went wrong. Please contact support. securitySchemes: APIKeyHeader: type: apiKey description: > This is the most secure authorization type and the one with the most flexibility. API keys can be generated by calling the dedicated API method. Furthermore, API keys can have a limited scope and cover only some API methods. Lastly, they can be revoked at any time. This range of possibilities makes API keys well suited for separating the API access rights across multiple applications or use cases. Finally, the loss of an API key is easily manageable. You can manage your API keys from [GUI](https://portal.phonovation.com/settings/accounts/api-keys), or programmatically with [dedicated API](#platform-&-connectivity/settings). API key Authorization header example: ```shell Authorization: App 003026bbc133714df1834b8638bb496e-8f4b3d9a-e931-478d-a994-28a725159ab9 ``` name: Authorization in: header x-default: 'App ' ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.