Creates a new mobile push credential

POST 
/mobile_push_credentials

Creates a new mobile push credential

Request

application/json

Body

required

Mobile push credential parameters that need to be sent in the request

oneOf

• Create iOS push credential request
• Create Android Push Credential Request

type stringrequired

Possible values: [ios]

Type of mobile push credential. Should be ios here

certificate stringrequired

Certificate as received from APNs

private_key stringrequired

Corresponding private key to the certificate as received from APNs

alias stringrequired

Alias to uniquely identify the credential

type stringrequired

Possible values: [android]

Type of mobile push credential. Should be android here

server_key stringrequired

Server key as received from Google firebase

alias stringrequired

Alias to uniquely identify the credential

Responses

200: Mobile push credential created

application/json

• Schema
• Example (from schema)

Schema

data

object

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

server_key stringrequired

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.

{
  "data": {
    "id": "0ccc7b54-4df3-4bcb-a65a-3da1ecc997d7",
    "certificate": "-----BEGIN CERTIFICATE----- MIIGVDCCBTKCAQEAsNlRJVZn9ZvXcECQm65czs... -----END CERTIFICATE-----",
    "private_key": "-----BEGIN RSA PRIVATE KEY----- MIIEpQIBAAKCAQEAsNlRJVZn9ZvXcECQm65czs... -----END RSA PRIVATE KEY-----",
    "server_key": "",
    "alias": "LucyCredential",
    "type": "ios",
    "record_type": "push_credential",
    "created_at": "2021-03-26T17:51:59.588408Z",
    "updated_at": "2021-03-26T17:51:59.588408Z"
  }
}

401: Unauthorized request

application/json

• Schema
• Example (from schema)

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"
      }
    }
  ]
}

422: Unable to process request

application/json

• Schema
• Example (from schema)

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"
      }
    }
  ]
}

Loading...