List mobile push credentials

GET /mobile_push_credentials

Request

Query Parameters

filter[type] string

Possible values: [ios, android]

type of mobile push credentials

filter[alias] string

Unique mobile push credential alias

page[size] integer

Possible values: >= 1 and <= 250

Default value: 20

The size of the page.

page[number] integer

Possible values: >= 1

Default value: 1

The page number to load.

Responses

200: Mobile mobile push credentials

application/json

Schema

data

object[]

Array [

id stringrequired

Unique identifier of a push credential

certificate stringrequired

Apple certificate for sending push notifications. For iOS only

private_key stringrequired

Apple private key for a given certificate for sending push notifications. For iOS only

project_account_json_file objectrequired

Google server key for sending push notifications. For Android only

alias stringrequired

Alias to uniquely identify a credential

type stringrequired

Type of mobile push credential. Either ios or android

record_type stringrequired

created_at datetimerequired

ISO 8601 timestamp when the room was created

updated_at datetimerequired

ISO 8601 timestamp when the room was updated.

]

meta

object

page_number integer

page_size integer

total_pages integer

total_results integer

{
  "data": [
    {
      "id": "0ccc7b54-4df3-4bcb-a65a-3da1ecc997d7",
      "certificate": "-----BEGIN CERTIFICATE----- MIIGVDCCBTKCAQEAsNlRJVZn9ZvXcECQm65czs... -----END CERTIFICATE-----",
      "private_key": "-----BEGIN RSA PRIVATE KEY----- MIIEpQIBAAKCAQEAsNlRJVZn9ZvXcECQm65czs... -----END RSA PRIVATE KEY-----",
      "project_account_json_file": {
        "private_key": "BBBB0J56jd8kda:APA91vjb11BCjvxx3Jxja...",
        "client_email": "[email protected]"
      },
      "alias": "LucyCredential",
      "type": "ios",
      "record_type": "push_credential",
      "created_at": "2021-03-26T17:51:59.588408Z",
      "updated_at": "2021-03-26T17:51:59.588408Z"
    }
  ],
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}

401: Unauthorized request

application/json

Schema

errors

Error[]

Array [

code intrequired

title stringrequired

detail string

source

object

pointer json-pointer

JSON pointer (RFC6901) to the offending entity.

parameter string

Indicates which query parameter caused the error.

meta object

]

{
  "errors": [
    {
      "code": 10015,
      "title": "Bad Request",
      "detail": "has already been taken",
      "source": {
        "pointer": "/mobile_push_credentials",
        "parameter": "application_name"
      },
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10015"
      }
    }
  ]
}

Request samples

curl -L 'https://api.telnyx.com/v2/mobile_push_credentials' \
-H 'Accept: application/json'

Response samples

{
  "data": [
    {
      "id": "0ccc7b54-4df3-4bcb-a65a-3da1ecc997d7",
      "certificate": "-----BEGIN CERTIFICATE----- MIIGVDCCBTKCAQEAsNlRJVZn9ZvXcECQm65czs... -----END CERTIFICATE-----",
      "private_key": "-----BEGIN RSA PRIVATE KEY----- MIIEpQIBAAKCAQEAsNlRJVZn9ZvXcECQm65czs... -----END RSA PRIVATE KEY-----",
      "project_account_json_file": {
        "private_key": "BBBB0J56jd8kda:APA91vjb11BCjvxx3Jxja...",
        "client_email": "[email protected]"
      },
      "alias": "LucyCredential",
      "type": "ios",
      "record_type": "push_credential",
      "created_at": "2021-03-26T17:51:59.588408Z",
      "updated_at": "2021-03-26T17:51:59.588408Z"
    }
  ],
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}

{
  "errors": [
    {
      "code": 10015,
      "title": "Bad Request",
      "detail": "has already been taken",
      "source": {
        "pointer": "/mobile_push_credentials",
        "parameter": "application_name"
      },
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10015"
      }
    }
  ]
}

List mobile push credentials

Request​

Query Parameters

Responses​

Request

Responses