Telnyx Push Credentials API

openapi: 3.2.0
info:
  title: Telnyx Push Credentials API
  version: 2.0.0
  contact:
    email: support@telnyx.com
  x-endpoint-cost: light
  x-refined-note:
  - x-latency-category differs across the merged source definitions and was not carried
  description: 'Operations tagged Push Credentials across 3 of this provider''s published API definitions: telnyx-openapi.json, telnyx-openapi.yml, telnyx-openapi_2.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.telnyx.com/v2
  description: Version 2.0.0 of the Telnyx API
security:
- bearerAuth: []
tags:
- name: Push Credentials
  description: Mobile push credential management
paths:
  /mobile_push_credentials:
    get:
      tags:
      - Push Credentials
      summary: List mobile push credentials
      description: Returns a paginated list of the mobile push credentials on your account, with support for filtering.
      operationId: ListPushCredentials
      parameters:
      - $ref: '#/components/parameters/push-notifications_PageConsolidated'
      - name: filter
        in: query
        style: deepObject
        explode: true
        description: 'Consolidated filter parameter (deepObject style). Originally: filter[type], filter[alias]'
        schema:
          type: object
          properties:
            type:
              type: string
              enum:
              - ios
              - android
              example: ios
              description: type of mobile push credentials
            alias:
              type: string
              example: LucyCredential
              description: Unique mobile push credential alias
      responses:
        '200':
          description: Mobile mobile push credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPushCredentialsResponse'
        '401':
          description: Unauthorized request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
    post:
      tags:
      - Push Credentials
      summary: Creates a new mobile push credential
      description: Creates a new mobile push credential for delivering push notifications to iOS or Android apps, and returns the created credential.
      operationId: CreatePushCredential
      parameters: []
      requestBody:
        description: Mobile push credential parameters that need to be sent in the request
        content:
          application/json:
            schema:
              oneOf:
              - $ref: '#/components/schemas/CreateIosPushCredentialRequest'
              - $ref: '#/components/schemas/CreateAndroidPushCredentialRequest'
        required: true
      responses:
        '200':
          description: Mobile push credential created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PushCredentialResponse'
        '401':
          description: Unauthorized request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '422':
          description: Unable to process request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
    servers:
    - url: https://api.telnyx.com/v2
      description: Version 2.0.0 of the Telnyx API
  /mobile_push_credentials/{push_credential_id}:
    delete:
      tags:
      - Push Credentials
      summary: Deletes a mobile push credential
      description: Deletes a mobile push credential based on the given `push_credential_id`
      operationId: DeletePushCredentialById
      parameters:
      - name: push_credential_id
        in: path
        description: The unique identifier of a mobile push credential
        required: true
        schema:
          type: string
          format: uuid
          example: 0ccc7b76-4df3-4bca-a05a-3da1ecc389f0
      responses:
        '204':
          description: The mobile push credential was deleted successfully
        '401':
          description: Unauthorized request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '422':
          description: Unable to process request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
    get:
      tags:
      - Push Credentials
      summary: Retrieves a mobile push credential
      description: Retrieves mobile push credential based on the given `push_credential_id`
      operationId: GetPushCredentialById
      parameters:
      - name: push_credential_id
        in: path
        description: The unique identifier of a mobile push credential
        required: true
        schema:
          type: string
          format: uuid
          example: 0ccc7b76-4df3-4bca-a05a-3da1ecc389f0
      responses:
        '200':
          description: Successful get mobile push credential response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PushCredentialResponse'
        '401':
          description: Unauthorized request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
        '422':
          description: Unable to process request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
    servers:
    - url: https://api.telnyx.com/v2
      description: Version 2.0.0 of the Telnyx API
components:
  schemas:
    PushCredentialResponse:
      description: Success response with details about a push credential
      properties:
        data:
          $ref: '#/components/schemas/PushCredential'
      type: object
    CreateIosPushCredentialRequest:
      type: object
      title: Create iOS push credential request
      required:
      - type
      - certificate
      - private_key
      - alias
      properties:
        type:
          description: Type of mobile push credential. Should be <code>ios</code> here
          type: string
          enum:
          - ios
        certificate:
          description: Certificate as received from APNs
          type: string
          example: '-----BEGIN CERTIFICATE----- MIIGVDCCBTKCAQEAsNlRJVZn9ZvXcECQm65czs... -----END CERTIFICATE-----'
        private_key:
          description: Corresponding private key to the certificate as received from APNs
          type: string
          example: REDACTED_PRIVATE_KEY_EXAMPLE
        alias:
          description: Alias to uniquely identify the credential
          type: string
          example: LucyIosCredential
    Errors:
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/billing-group_Error'
      type: object
    PushCredential:
      type: object
      title: Successful response with details about a push credential
      required:
      - id
      - certificate
      - private_key
      - project_account_json_file
      - alias
      - type
      - record_type
      - created_at
      - updated_at
      properties:
        id:
          description: Unique identifier of a push credential
          type: string
          example: 0ccc7b54-4df3-4bcb-a65a-3da1ecc997d7
        certificate:
          description: Apple certificate for sending push notifications. For iOS only
          type: string
          example: '-----BEGIN CERTIFICATE----- MIIGVDCCBTKCAQEAsNlRJVZn9ZvXcECQm65czs... -----END CERTIFICATE-----'
        private_key:
          description: Apple private key for a given certificate for sending push notifications. For iOS only
          type: string
          example: REDACTED_PRIVATE_KEY_EXAMPLE
        project_account_json_file:
          description: Google server key for sending push notifications. For Android only
          type: object
          example:
            private_key: BBBB0J56jd8kda:APA91vjb11BCjvxx3Jxja...
            client_email: account@customer.org
          additionalProperties: true
        alias:
          description: Alias to uniquely identify a credential
          type: string
          example: LucyCredential
        type:
          description: Type of mobile push credential. Either <code>ios</code> or <code>android</code>
          type: string
          example: ios
        record_type:
          type: string
          example: push_credential
          readOnly: true
        created_at:
          description: ISO 8601 timestamp when the room was created
          type: string
          format: date-time
          example: '2021-03-26T17:51:59.588408Z'
        updated_at:
          description: ISO 8601 timestamp when the room was updated.
          type: string
          format: date-time
          example: '2021-03-26T17:51:59.588408Z'
    PaginationMeta:
      type: object
      properties:
        total_pages:
          type: integer
          example: 3
        total_results:
          type: integer
          example: 55
        page_number:
          type: integer
          example: 2
        page_size:
          type: integer
          example: 25
    billing-group_Error:
      type: object
      required:
      - code
      - title
      properties:
        code:
          type: integer
          format: int32
        title:
          type: string
        detail:
          type: string
        source:
          type: object
          properties:
            pointer:
              description: JSON pointer (RFC6901) to the offending entity.
              type: string
            parameter:
              description: Indicates which query parameter caused the error.
              type: string
        meta:
          type: object
          properties: {}
          additionalProperties: true
    CreateAndroidPushCredentialRequest:
      type: object
      title: Create Android Push Credential Request
      required:
      - type
      - project_account_json_file
      - alias
      properties:
        type:
          description: Type of mobile push credential. Should be <code>android</code> here
          type: string
          enum:
          - android
        project_account_json_file:
          description: Private key file in JSON format
          type: object
          example:
            private_key: BBBB0J56jd8kda:APA91vjb11BCjvxx3Jxja...
            client_email: account@customer.org
          additionalProperties: true
        alias:
          description: Alias to uniquely identify the credential
          type: string
          example: LucyAndroidCredential
    ListPushCredentialsResponse:
      description: Mobile mobile push credentials
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/PushCredential'
        meta:
          $ref: '#/components/schemas/PaginationMeta'
      type: object
    push-notifications_Error:
      properties:
        code:
          example: '10015'
          type: string
        detail:
          example: has already been taken
          type: string
        meta:
          additionalProperties: true
          example:
            url: https://developers.telnyx.com/docs/overview/errors/10015
          type: object
        source:
          properties:
            parameter:
              description: Indicates which query parameter caused the error.
              example: application_name
              type: string
            pointer:
              description: JSON pointer (RFC6901) to the offending entity.
              example: /mobile_push_credentials
              type: string
          type: object
        title:
          example: Bad Request
          type: string
      required:
      - code
      - title
      type: object
    push-notifications_Errors:
      properties:
        errors:
          items:
            $ref: '#/components/schemas/push-notifications_Error'
          type: array
      type: object
    Errors_2:
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
      type: object
    Error:
      required:
      - code
      - title
      properties:
        code:
          type: string
          x-format: int64
        title:
          type: string
        detail:
          type: string
          description: A human-readable explanation of the error.
        description:
          type: string
        source:
          type: object
          properties:
            pointer:
              description: JSON pointer (RFC6901) to the offending entity.
              type: string
              format: json-pointer
            parameter:
              description: Indicates which query parameter caused the error.
              type: string
        meta:
          type: object
          additionalProperties: true
      example:
        title: Invalid street address
        source:
          pointer: /street_address
        code: '20207'
        description: The street address provided is invalid.
      type: object
  parameters:
    push-notifications_PageConsolidated:
      name: page
      in: query
      style: deepObject
      explode: true
      description: 'Consolidated page parameter (deepObject style). Originally: page[size], page[number]'
      schema:
        type: object
        properties:
          size:
            type: integer
            minimum: 1
            maximum: 250
            default: 20
            description: The size of the page.
          number:
            type: integer
            minimum: 1
            default: 1
            description: The page number to load.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: 'Telnyx API key supplied as `Authorization: Bearer <token>`. In production, auth may be validated by the API gateway and forwarded via Telnyx auth headers.'
    Payment:
      type: apiKey
      in: header
      name: Authorization
      description: 'Machine Payment Protocol credential used on paid retries, sent as `Authorization: Payment ...`. Obtained by paying a challenge returned in the `WWW-Authenticate` header of a 402 response. This is not a Telnyx API key; initial challenge requests use standard bearer authentication instead.'
    agent-memory_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key
    bearerAuth:
      type: http
      scheme: bearer
    branded-calling_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key. Generate one at https://portal.telnyx.com/#/app/api-keys.
    collections_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key. Collections and results are automatically scoped to the authenticated user's organization.
    number-reputation_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key. Generate one at https://portal.telnyx.com/#/app/api-keys.
    oauthClientAuth:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://api.telnyx.com/v2/oauth/token
          scopes:
            admin: Administrative access to Telnyx resources
        authorizationCode:
          authorizationUrl: https://api.telnyx.com/v2/oauth/authorize
          tokenUrl: https://api.telnyx.com/v2/oauth/token
          refreshUrl: https://api.telnyx.com/v2/oauth/token
          scopes:
            admin: Administrative access to Telnyx resources
      description: OAuth 2.0 authentication for Telnyx API and MCP integrations
    outbound-voice-profiles_bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    pronunciation-dicts_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API v2 key. Obtain from https://portal.telnyx.com
    rcs-registration_bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
    stored-payment-transactions_bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    transcriptions-search_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key. Results are automatically scoped to the authenticated user's organization.
    web-search_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key
    pay-connectors_bearerAuth:
      type: http
      scheme: bearer
      description: Telnyx API key, not the processor bearer token.
    telnyxApiKey:
      type: http
      scheme: bearer
      description: Management-only Telnyx account credential.
x-refined-from:
- telnyx-openapi.json
- telnyx-openapi.yml
- telnyx-openapi_2.json
x-service-info:
  categories:
  - communication
  - developer-tools
  docs:
    apiReference: https://developers.telnyx.com
    homepage: https://telnyx.com
    llms: https://telnyx.com/llms.txt