List WhatsApp number events
/v1/whatsapp/numbers/{number_id}/eventsfor await (const event of bird.whatsapp.numbers.listEvents(
"wan_01krdgeqcxet5s7t44vh8rt9mg",
)) {
console.log(event.created_at, event.type, event.summary);
}for event in client.whatsapp.numbers.list_events("wan_01krdgeqcxet5s7t44vh8rt9mg"):
print(event.created_at, event.type, event.summary)for event, err := range client.Whatsapp.Numbers.ListEvents(context.Background(), "wan_01krdgeqcxet5s7t44vh8rt9mg", bird.WhatsappNumbersListEventsParams{}) {
if err != nil {
log.Fatal(err)
}
fmt.Println(event.CreatedAt, event.Type, event.Summary)
}foreach ($bird->whatsapp->numbers->listEvents('wan_01krdgeqcxet5s7t44vh8rt9mg') as $event) {
echo $event->getCreatedAt()?->format(DATE_ATOM), ' ', $event->getType(), "\n";
}bird whatsapp numbers list-events <number-id>curl -X GET "https://us1.platform.bird.com/v1/whatsapp/numbers/{number_id}/events" \
-H "Authorization: Bearer $TOKEN" \
--url-query "sort=created_at" \
--url-query "order=desc" \
--url-query "limit=25"{
"data": [
{
"id": "wne_01krdgeqcxet5s7t44vh8rt9mg",
"type": "whatsapp_number.quality_rating_updated",
"summary": "Quality rating dropped to medium."
}
],
"next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
"prev_cursor": null,
"refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}
Returns the number's activity history, newest first by default:
- The number being added, and every change of its status.
- A messaging-limit change reported by WhatsApp.
- A display-name review decision.
- A quality-rating change, observed when Bird next reads the number.
Use it to see when and why a number's status, limit, name, or quality changed,
rather than polling Get a WhatsApp number.
A number ID that does not belong to the workspace, or no longer exists,
returns 404.
Paramètres
number_idstringID of the WhatsApp number whose events to list.
Paramètres de requête
sortstringField to sort by. Defaults to created_at.
Possible values: created_at
orderstringSort direction. Defaults to desc, which sorts from newest to oldest or largest to smallest, depending on the selected sort field.
Possible values: asc, desc
limitintegerMaximum number of items to return per page.
starting_afterstringCursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.
ending_beforestringCursor from the prev_cursor or refresh_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order. prev_cursor returns the preceding page. refresh_cursor anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.
Contenu de la réponse
dataPage of number events, newest first by default.
next_cursorCursor for the next page. Pass back as starting_after to advance forward. null when no next page exists.
prev_cursorCursor for the previous page. Pass back as ending_before to step backward. null when no previous page exists.
refresh_cursorRefresh anchor, the first row of this response. Pass back as ending_before to fetch what precedes it in the current sort order. On a newest-first sort those are the items that have appeared since; on any other sort they are the items that sort earlier, so refreshing such a list means re-fetching it instead. Non-null whenever data is non-empty; null only on an empty page. Distinct from prev_cursor.
Ressources associées
Poursuivez avec la documentation, les guides et les exemples sur ce sujet.