@@ -8960,6 +8960,134 @@ paths:
8960
8960
id: 6762f23b1bb69f9f2193bc1d
8961
8961
message_type: sms
8962
8962
body: heyy https://picsum.photos/200/300
8963
+ "/messages/status":
8964
+ get:
8965
+ summary: Get statuses of all messages sent based on the specified ruleset_id
8966
+ parameters:
8967
+ - name: Intercom-Version
8968
+ in: header
8969
+ schema:
8970
+ "$ref": "#/components/schemas/intercom_version"
8971
+ - name: ruleset_id
8972
+ in: query
8973
+ required: true
8974
+ description: The unique identifier for the set of messages to check status for
8975
+ schema:
8976
+ type: string
8977
+ - name: per_page
8978
+ in: query
8979
+ required: false
8980
+ description: Number of results per page (default 50, max 100)
8981
+ schema:
8982
+ type: integer
8983
+ default: 50
8984
+ maximum: 100
8985
+ - name: starting_after
8986
+ in: query
8987
+ required: false
8988
+ description: Cursor for pagination, used to fetch the next page of results
8989
+ schema:
8990
+ type: string
8991
+ tags:
8992
+ - Messages
8993
+ - WhatsApp
8994
+ operationId: getWhatsAppMessageStatus
8995
+ description: |
8996
+ Retrieves statuses of messages sent from the Outbound module. Currently, this API only supports WhatsApp messages.
8997
+
8998
+
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.
9001
+ responses:
9002
+ '200':
9003
+ description: Successful response
9004
+ content:
9005
+ application/json:
9006
+ examples:
9007
+ Successful response:
9008
+ value:
9009
+ type: list
9010
+ ruleset_id: 12345
9011
+ pages:
9012
+ type: pages
9013
+ per_page: 50
9014
+ total_pages: 3
9015
+ next:
9016
+ starting_after: "abc123"
9017
+ total_count: 125
9018
+ events:
9019
+ - id: "event_1"
9020
+ conversation_id: "conv_123"
9021
+ user_id: "user_123"
9022
+ status: "delivered"
9023
+ type: "broadcast_outbound"
9024
+ created_at: 1734537980
9025
+ updated_at: 1734538000
9026
+ whatsapp_message_id: "wamid_123"
9027
+ template_name: "appointment_reminder"
9028
+ - id: "event_2"
9029
+ conversation_id: "conv_456"
9030
+ user_id: "user_456"
9031
+ status: "sent"
9032
+ type: "broadcast_outbound"
9033
+ created_at: 1734537970
9034
+ updated_at: 1734538010
9035
+ whatsapp_message_id: "wamid_456"
9036
+ template_name: "order_update"
9037
+ schema:
9038
+ "$ref": "#/components/schemas/whatsapp_message_status_list"
9039
+ '400':
9040
+ description: Bad request - missing required parameters
9041
+ content:
9042
+ application/json:
9043
+ examples:
9044
+ missing ruleset_id:
9045
+ value:
9046
+ type: error
9047
+ request_id: "req_123"
9048
+ message: "ruleset_id is required"
9049
+ schema:
9050
+ "$ref": "#/components/schemas/error"
9051
+ '401':
9052
+ description: Unauthorized
9053
+ content:
9054
+ 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
9063
+ schema:
9064
+ "$ref": "#/components/schemas/error"
9065
+ '403':
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
9081
+ content:
9082
+ application/json:
9083
+ examples:
9084
+ server error:
9085
+ value:
9086
+ type: error
9087
+ request_id: 591a0c2f-78b3-41bb-bfa7-f1fae15107b2
9088
+ message: "Request failed due to an internal error. Please reach out to support"
9089
+ schema:
9090
+ "$ref": "#/components/schemas/error"
8963
9091
"/news/news_items":
8964
9092
get:
8965
9093
summary: List all news items
@@ -18025,6 +18153,87 @@ components:
18025
18153
- created_at
18026
18154
- body
18027
18155
- 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: ["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
18028
18237
multiple_filter_search_request:
18029
18238
title: Multiple Filter Search Request
18030
18239
description: Search using Intercoms Search APIs with more than one filter.
0 commit comments