@@ -8962,7 +8962,7 @@ paths:
89628962 body: heyy https://picsum.photos/200/300
89638963 "/messages/status":
89648964 get:
8965- summary: Get WhatsApp message status
8965+ summary: Get statuses of all messages sent based on the specified ruleset_id
89668966 parameters:
89678967 - name: Intercom-Version
89688968 in: header
@@ -8971,7 +8971,7 @@ paths:
89718971 - name: ruleset_id
89728972 in: query
89738973 required: true
8974- description: The unique identifier for the set of WhatsApp messages to check status for
8974+ description: The unique identifier for the set of messages to check status for
89758975 schema:
89768976 type: string
89778977 - name: per_page
@@ -8993,14 +8993,11 @@ paths:
89938993 - WhatsApp
89948994 operationId: getWhatsAppMessageStatus
89958995 description: |
8996- Retrieves the status of outbound WhatsApp messages based on a ruleset ID .
8996+ Retrieves statuses of messages sent from the Outbound module. Currently, this API only supports WhatsApp messages .
89978997
8998- This endpoint returns paginated status events for WhatsApp messages, providing
8999- information about delivery state and related message details.
90008998
9001- > 🚧 Feature Flag Required
9002- >
9003- > This endpoint requires the "team-channels-whatsapp-outbound-api" feature to be enabled.
8999+ This endpoint returns paginated status events for WhatsApp messages sent via the Outbound module, providing
9000+ information about delivery state and related message details.
90049001 responses:
90059002 '200':
90069003 description: Successful response
@@ -9009,10 +9006,10 @@ paths:
90099006 examples:
90109007 Successful response:
90119008 value:
9012- type: " list"
9013- ruleset_id: " 12345"
9009+ type: list
9010+ ruleset_id: 12345
90149011 pages:
9015- type: " pages"
9012+ type: pages
90169013 per_page: 50
90179014 total_pages: 3
90189015 next:
@@ -9021,6 +9018,7 @@ paths:
90219018 events:
90229019 - id: "event_1"
90239020 conversation_id: "conv_123"
9021+ user_id: "user_123"
90249022 status: "delivered"
90259023 type: "broadcast_outbound"
90269024 created_at: 1734537980
@@ -9029,93 +9027,15 @@ paths:
90299027 template_name: "appointment_reminder"
90309028 - id: "event_2"
90319029 conversation_id: "conv_456"
9030+ user_id: "user_456"
90329031 status: "sent"
90339032 type: "broadcast_outbound"
90349033 created_at: 1734537970
90359034 updated_at: 1734538010
90369035 whatsapp_message_id: "wamid_456"
90379036 template_name: "order_update"
90389037 schema:
9039- type: object
9040- required:
9041- - type
9042- - ruleset_id
9043- - pages
9044- - total_count
9045- - events
9046- properties:
9047- type:
9048- type: string
9049- enum: ["list"]
9050- ruleset_id:
9051- type: string
9052- description: The provided ruleset ID
9053- pages:
9054- type: object
9055- required:
9056- - type
9057- - per_page
9058- - total_pages
9059- properties:
9060- type:
9061- type: string
9062- enum: ["pages"]
9063- per_page:
9064- type: integer
9065- description: Number of results per page
9066- total_pages:
9067- type: integer
9068- description: Total number of pages
9069- next:
9070- type: object
9071- nullable: true
9072- description: Information for fetching next page (null if no more pages)
9073- properties:
9074- starting_after:
9075- type: string
9076- description: Cursor for the next page
9077- total_count:
9078- type: integer
9079- description: Total number of events
9080- events:
9081- type: array
9082- items:
9083- type: object
9084- required:
9085- - id
9086- - conversation_id
9087- - status
9088- - type
9089- - created_at
9090- - updated_at
9091- - whatsapp_message_id
9092- properties:
9093- id:
9094- type: string
9095- description: Event ID
9096- conversation_id:
9097- type: string
9098- description: ID of the conversation
9099- status:
9100- type: string
9101- description: Current status of the message
9102- enum: ["queued", "sent", "delivered", "read", "failed"]
9103- type:
9104- type: string
9105- description: Event type
9106- enum: ["broadcast_outbound"]
9107- created_at:
9108- type: integer
9109- description: Creation timestamp
9110- updated_at:
9111- type: integer
9112- description: Last update timestamp
9113- whatsapp_message_id:
9114- type: string
9115- description: WhatsApp's message identifier
9116- template_name:
9117- type: string
9118- description: Name of the WhatsApp template used
9038+ "$ref": "#/components/schemas/whatsapp_message_status_list"
91199039 '400':
91209040 description: Bad request - missing required parameters
91219041 content:
@@ -9126,22 +9046,48 @@ paths:
91269046 type: error
91279047 request_id: "req_123"
91289048 message: "Missing required parameter: ruleset_id"
9049+ schema:
9050+ "$ref": "#/components/schemas/error"
91299051 '401':
91309052 description: Unauthorized
91319053 content:
91329054 application/json:
9055+ examples:
9056+ Unauthorized:
9057+ value:
9058+ type: error.list
9059+ request_id: d7997515-cd92-4fe4-966c-cb1f4bdda1d4
9060+ errors:
9061+ - code: unauthorized
9062+ message: Access Token Invalid
91339063 schema:
9134- "$ref": "#/components/schemas/authentication_error "
9064+ "$ref": "#/components/schemas/error "
91359065 '403':
9136- description: Forbidden - feature flag not enabled
9066+ description: API plan restricted
9067+ content:
9068+ application/json:
9069+ examples:
9070+ API plan restricted:
9071+ value:
9072+ type: error.list
9073+ request_id: 591a0c2f-78b3-41bb-bfa7-f1fae15107b0
9074+ errors:
9075+ - code: api_plan_restricted
9076+ message: Active subscription needed.
9077+ schema:
9078+ "$ref": "#/components/schemas/error"
9079+ '500':
9080+ description: Internal server error
91379081 content:
91389082 application/json:
91399083 examples:
9140- feature not enabled :
9084+ server error :
91419085 value:
91429086 type: error
9143- request_id: "req_456"
9144- message: "Feature 'team-channels-whatsapp-outbound-api' is not enabled for this workspace"
9087+ request_id: 591a0c2f-78b3-41bb-bfa7-f1fae15107b2
9088+ message: "An error occurred while processing your request"
9089+ schema:
9090+ "$ref": "#/components/schemas/error"
91459091 "/news/news_items":
91469092 get:
91479093 summary: List all news items
@@ -18207,6 +18153,87 @@ components:
1820718153 - created_at
1820818154 - body
1820918155 - message_type
18156+ whatsapp_message_status_list:
18157+ type: object
18158+ required:
18159+ - type
18160+ - ruleset_id
18161+ - pages
18162+ - total_count
18163+ - events
18164+ properties:
18165+ type:
18166+ type: string
18167+ enum: ["list"]
18168+ ruleset_id:
18169+ type: string
18170+ description: The provided ruleset ID
18171+ pages:
18172+ type: object
18173+ required:
18174+ - type
18175+ - per_page
18176+ - total_pages
18177+ properties:
18178+ type:
18179+ type: string
18180+ enum: ["pages"]
18181+ per_page:
18182+ type: integer
18183+ description: Number of results per page
18184+ total_pages:
18185+ type: integer
18186+ description: Total number of pages
18187+ next:
18188+ type: object
18189+ nullable: true
18190+ description: Information for fetching next page (null if no more pages)
18191+ properties:
18192+ starting_after:
18193+ type: string
18194+ description: Cursor for the next page
18195+ total_count:
18196+ type: integer
18197+ description: Total number of events
18198+ events:
18199+ type: array
18200+ items:
18201+ type: object
18202+ required:
18203+ - id
18204+ - conversation_id
18205+ - status
18206+ - type
18207+ - created_at
18208+ - updated_at
18209+ - whatsapp_message_id
18210+ properties:
18211+ id:
18212+ type: string
18213+ description: Event ID
18214+ conversation_id:
18215+ type: string
18216+ description: ID of the conversation
18217+ status:
18218+ type: string
18219+ description: Current status of the message
18220+ enum: ["queued", "sent", "delivered", "read", "failed"]
18221+ type:
18222+ type: string
18223+ description: Event type
18224+ enum: ["broadcast_outbound"]
18225+ created_at:
18226+ type: integer
18227+ description: Creation timestamp
18228+ updated_at:
18229+ type: integer
18230+ description: Last update timestamp
18231+ whatsapp_message_id:
18232+ type: string
18233+ description: WhatsApp's message identifier
18234+ template_name:
18235+ type: string
18236+ description: Name of the WhatsApp template used
1821018237 multiple_filter_search_request:
1821118238 title: Multiple Filter Search Request
1821218239 description: Search using Intercoms Search APIs with more than one filter.
0 commit comments