URI HTTP methods Schemas Properties See also

APNs VoIP Channel

A channel is a type of platform that you can deliver messages to. You can use the APNs VoIP channel to send VoIP notification messages to the Apple Push Notification service (APNs). Before you can use Amazon Pinpoint to send VoIP notification messages to APNs, you must enable the APNs VoIP channel for an Amazon Pinpoint application.

The APNs VoIP Channel resource represents the status and authentication settings of the APNs VoIP channel for a specific application. You can use this resource to enable, retrieve information about, update, or disable (delete) the APNs VoIP channel for an application.

URI

/v1/apps/application-id/channels/apns_voip

HTTP methods

GET

Operation ID: GetApnsVoipChannel

Retrieves information about the status and settings of the APNs VoIP channel for an application.

Path parameters
Name	Type	Required	Description
`application-id`	String	True	The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Header parameters
Name	Type	Required	Description
`accept`	String	False	Indicates which content types, expressed as MIME types, the client understands.

Responses
Status code	Response model	Description
`200`	`APNSVoipChannelResponse`	The request succeeded.
`400`	`MessageBody`	The request contains a syntax error (BadRequestException).
`403`	`MessageBody`	The request was denied because access to the specified resource is forbidden (ForbiddenException).
`404`	`MessageBody`	The request failed because the specified resource was not found (NotFoundException).
`405`	`MessageBody`	The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
`413`	`MessageBody`	The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
`429`	`MessageBody`	The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
`500`	`MessageBody`	The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

PUT

Operation ID: UpdateApnsVoipChannel

Enables the APNs VoIP channel for an application or updates the status and settings of the APNs VoIP channel for an application.

Path parameters
Name	Type	Required	Description
`application-id`	String	True	The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Header parameters
Name	Type	Required	Description
`accept`	String	False	Indicates which content types, expressed as MIME types, the client understands.

Responses
Status code	Response model	Description
`200`	`APNSVoipChannelResponse`	The request succeeded.
`400`	`MessageBody`	The request contains a syntax error (BadRequestException).
`403`	`MessageBody`	The request was denied because access to the specified resource is forbidden (ForbiddenException).
`404`	`MessageBody`	The request failed because the specified resource was not found (NotFoundException).
`405`	`MessageBody`	The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
`413`	`MessageBody`	The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
`429`	`MessageBody`	The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
`500`	`MessageBody`	The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

DELETE

Operation ID: DeleteApnsVoipChannel

Disables the APNs VoIP channel for an application and deletes any existing settings for the channel.

Path parameters
Name	Type	Required	Description
`application-id`	String	True	The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Header parameters
Name	Type	Required	Description
`accept`	String	False	Indicates which content types, expressed as MIME types, the client understands.

Responses
Status code	Response model	Description
`200`	`APNSVoipChannelResponse`	The request succeeded.
`400`	`MessageBody`	The request contains a syntax error (BadRequestException).
`403`	`MessageBody`	The request was denied because access to the specified resource is forbidden (ForbiddenException).
`404`	`MessageBody`	The request failed because the specified resource was not found (NotFoundException).
`405`	`MessageBody`	The request failed because the method is not allowed for the specified resource (MethodNotAllowedException).
`413`	`MessageBody`	The request failed because the payload for the body of the request is too large (RequestEntityTooLargeException).
`429`	`MessageBody`	The request failed because too many requests were sent during a certain amount of time (TooManyRequestsException).
`500`	`MessageBody`	The request failed due to an unknown internal server error, exception, or failure (InternalServerErrorException).

OPTIONS

Retrieves information about the communication requirements and options that are available for the APNs VoIP Channel resource.

Path parameters
Name	Type	Required	Description
`application-id`	String	True	The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

Responses
Status code	Response model	Description
`200`	None	The request succeeded.

Schemas

Request bodies


{
  "Certificate": "string",
  "PrivateKey": "string",
  "Enabled": boolean,
  "TokenKeyId": "string",
  "TeamId": "string",
  "TokenKey": "string",
  "BundleId": "string",
  "DefaultAuthenticationMethod": "string"
}

Response bodies


{
  "ApplicationId": "string",
  "IsArchived": boolean,
  "Version": integer,
  "CreationDate": "string",
  "LastModifiedDate": "string",
  "LastModifiedBy": "string",
  "Id": "string",
  "Enabled": boolean,
  "HasCredential": boolean,
  "Platform": "string",
  "HasTokenKey": boolean,
  "DefaultAuthenticationMethod": "string"
}


{
  "RequestID": "string",
  "Message": "string"
}

Properties

APNSVoipChannelRequest

Specifies the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application.

Property	Type	Required	Description
`BundleId`	string	False	The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.
`Certificate`	string	False	The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate.
`DefaultAuthenticationMethod`	string	False	The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs, key or certificate.
`Enabled`	boolean	False	Specifies whether to enable the APNs VoIP channel for the application.
`PrivateKey`	string	False	The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.
`TeamId`	string	False	The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.
`TokenKey`	string	False	The authentication key to use for APNs tokens.
`TokenKeyId`	string	False	The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with APNs by using APNs tokens.

APNSVoipChannelResponse

Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application.

Property	Type	Required	Description
`ApplicationId`	string	False	The unique identifier for the application that the APNs VoIP channel applies to.
`CreationDate`	string	False	The date and time when the APNs VoIP channel was enabled.
`DefaultAuthenticationMethod`	string	False	The default authentication method that Amazon Pinpoint uses to authenticate with APNs for this channel, key or certificate.
`Enabled`	boolean	False	Specifies whether the APNs VoIP channel is enabled for the application.
`HasCredential`	boolean	False	(Not used) This property is retained only for backward compatibility.
`HasTokenKey`	boolean	False	Specifies whether the APNs VoIP channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the `TokenKey` property of the channel.
`Id`	string	False	(Deprecated) An identifier for the APNs VoIP channel. This property is retained only for backward compatibility.
`IsArchived`	boolean	False	Specifies whether the APNs VoIP channel is archived.
`LastModifiedBy`	string	False	The user who last modified the APNs VoIP channel.
`LastModifiedDate`	string	False	The date and time when the APNs VoIP channel was last modified.
`Platform`	string	True	The type of messaging or notification platform for the channel. For the APNs VoIP channel, this value is `APNS_VOIP`.
`Version`	integer	False	The current version of the APNs VoIP channel.

MessageBody

Provides information about an API request or response.

Property	Type	Required	Description
`Message`	string	False	The message that's returned from the API.
`RequestID`	string	False	The unique identifier for the request or response.