Passa al contenuto principale

Ottieni lo stato di consegna di un singolo messaggio

GET 
/api/partner-gateway/v1/messages/status/:customerMessageId

Returns the current delivery status of a single message identified by its customerMessageId. The customerMessageId is the unique identifier that the platform assigns to your message when you send it through one of the send endpoints (POST /partner-gateway/v1/sms/messages, POST /partner-gateway/v1/rcs/messages, or POST /partner-gateway/v1/whatsapp/messages). You should store this identifier on your side immediately after a successful send call so that you can track the message lifecycle later. Typical workflow: (1) Send a message via the appropriate channel endpoint and receive the customerMessageId in the response. (2) Wait a reasonable amount of time for carrier processing (a few seconds for SMS, potentially longer for RCS and WhatsApp). (3) Call this endpoint with the customerMessageId and the matching channel to retrieve the current status. The channel query parameter is mandatory and must exactly match the channel used to send the message. Supplying a mismatched channel (for example, querying an SMS message with channel=RCS) will result in a 404 because the lookup is scoped to the specified channel. Possible delivery statuses and their meanings: SENT - the message has been accepted by the platform and forwarded to the carrier or channel provider, but no delivery confirmation has been received yet. DELIVERED - the carrier or channel provider confirmed that the message reached the recipient device. RECEIVED - the message was received by the downstream system but final delivery to the handset is not yet confirmed. ERROR - the message could not be delivered; check the deliveryStatoDescription field for the specific reason (common causes include invalid destination number, carrier rejection, or account suspension). EXPIRED - the message was not delivered within the allowed time-to-live window and the carrier discarded it. UNKNOWN - the platform has no status information for this message, which may indicate that the carrier did not return a delivery receipt or that the message is still being processed. Error responses: 404 is returned when the customerMessageId does not exist for the given channel and company, or when the channel parameter does not match the original send channel. 500 indicates an unexpected server-side error; retry the request after a short delay. For bulk status checks, use the batch endpoint GET /partner-gateway/v1/messages/status instead.

Richiesta​

Risposte​

Stato di consegna trovato

Ultimo aggiornamento il