One contact's messages, both directions
https://api.app2email.com/v1/{number}/conversations/{phone}/messages The messages with one contact, newest first. window_open says whether a free-form reply can be sent now.
Path
-
Your app2email WhatsApp number - the number the message is sent FROM. Full number with country code, digits only.
e.g.4976659348270 -
The contact's number, with country code, or their business-scoped user id.
e.g.61412345678
Query
- since string (date-time)
At or after this time. ISO 8601.
- until string (date-time)
Before this time. ISO 8601.
-
How many (1 to 200, default 50).
- cursor string
The next_cursor of the previous answer, unchanged. Leave out for the first page.
Responses
Fields
- success boolean
- request_id string
- contact stringe.g.
61412345678 - window_open boolean
- window_closes_at string (date-time)
- owner string
Left out for the normal routing.
agenthumanpaused - messages object[]
17 item fields
- direction string
inout - message_id stringe.g.
wamid.HBgLNjE0MTIzNDU2NzgVAgARGBJTQU1QTEVfVEVTVF9FVkVOVAA= - to string
direction out.
e.g.61412345678 - from string
direction in: the contact's number, or their business-scoped user id when no number is known.
e.g.61412345678 - from_user_id string
direction in: the contact's business-scoped user id, when WhatsApp sent one.
- media_url string
direction in, media messages: app2email's stored copy (GET /media/{message_id}, with your key). WhatsApp's own media ids expire after 7 days.
- name string
direction in: the contact's name.
- status string
direction out.
queuedacceptedsentdeliveredreadfaileddeletedunknown - sent_by string
- broadcast_code string
- text string
- media string
- time string (date-time)
- times object
direction out.
- error object
direction out, when it failed.
1 fields
- message string
- reply object
direction out: the contact's reply.
- conversation_url string
- next_cursor string
- count integer
Errors
- 400 The request is malformed (missing or invalid fields, query parameters or times).
- 401 Missing, invalid, revoked or expired API key.
- 403 The key is valid but this call is not allowed: the key lacks the scope the call needs (insufficient_scope), the address is not allowed for the key (ip_not_allowed), the number or plan does not allow it, a recipient opted out or is not opted in, or a problem with the WhatsApp account.
- 429 A monthly plan limit, the number's own monthly cap, the key's daily cap, a WhatsApp rate limit, the API rate limit (rate_limited), or the webhook test limit (too_many_tests) was reached. Retry-After and error.retry_after_seconds say how long to wait.
- 500 Unexpected error on app2email's side.