Checking the status of sending with clientTransferId

Returns the status of sending by using the ID that been set during the request in the group.

It allows you to check the status of sending using the specified ID set by a user, if you can not get the transferId.

Request format

GET https://push.api.appmetrica.yandex.net/push/v1/status/{groupId}/{clientTransferId}

groupId

Group ID.

clientTransferId

Sending ID, specified by the user.

Response format

{
  "transfer": {
    "id": 1,
    "group_id": 1,
    "status": "failed",
    "errors": [
      "Identifier type google_aid requires defined message for platform android"
    ],
    "tag": "string",
    "creation_date": "2017-08-28T17:30:15+03:00",
    "client_transfer_id": 12345
  }
}

transfer

Information about the dispatch.

transfer.id

ID of the dispatch.

transfer.group_id

Group ID.

transfer.status

The dispatch status. Possible values:

  • failed: The request failed validation. The reason is in the errors field.
  • in_progress: The request was successfully validated. A dispatch is in progress.
  • pending: The request has been accepted and is awaiting validation.
  • sent: Dispatch completed.

transfer.errors

Description of the validation error. The field is available with the failed status.

transfer.tag

The sending tag.

transfer.creation_date

The date the dispatch request was created.

transfer.client_transfer_id

Sending ID specified by the user in the body of the POST /push/v1/send-batch request.

If you didn't find the answer you were looking for, you can use the feedback form to submit your question. Please describe the problem in as much detail as possible. Attach a screenshot if possible.

Contact support
Previous
Checking the status of a dispatch with transferId
Next
File types in push messages
In this article: