DeleteApnsSandboxChannel
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
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
HTTP methods
Name Type Required Description
MIME types, the client understands.
Responses
Status code Response model Description
200 APNSVoipChannelResponse (p. 47)The request succeeded.
400 MessageBody (p. 48) The request contains a syntax
error (BadRequestException).
403 MessageBody (p. 48) The request was denied
because access to the
specified resource is forbidden (ForbiddenException).
404 MessageBody (p. 48) The request failed because the
specified resource was not found (NotFoundException).
405 MessageBody (p. 48) The request failed because
the method is not allowed for the specified resource (MethodNotAllowedException).
413 MessageBody (p. 48) The request failed because
the payload for the body of the request is too large
(RequestEntityTooLargeException).
429 MessageBody (p. 48) The request failed because
too many requests were sent during a certain amount of time (TooManyRequestsException).
500 MessageBody (p. 48) 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
HTTP methods
Name Type Required Description
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 (p. 47)The request succeeded.
400 MessageBody (p. 48) The request contains a syntax
error (BadRequestException).
403 MessageBody (p. 48) The request was denied
because access to the
specified resource is forbidden (ForbiddenException).
404 MessageBody (p. 48) The request failed because the
specified resource was not found (NotFoundException).
405 MessageBody (p. 48) The request failed because
the method is not allowed for the specified resource (MethodNotAllowedException).
413 MessageBody (p. 48) The request failed because
the payload for the body of the request is too large
(RequestEntityTooLargeException).
429 MessageBody (p. 48) The request failed because
too many requests were sent during a certain amount of time (TooManyRequestsException).
500 MessageBody (p. 48) 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.
HTTP methods
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 (p. 47)The request succeeded.
400 MessageBody (p. 48) The request contains a syntax
error (BadRequestException).
403 MessageBody (p. 48) The request was denied
because access to the
specified resource is forbidden (ForbiddenException).
404 MessageBody (p. 48) The request failed because the
specified resource was not found (NotFoundException).
405 MessageBody (p. 48) The request failed because
the method is not allowed for the specified resource (MethodNotAllowedException).
413 MessageBody (p. 48) The request failed because
the payload for the body of the request is too large
(RequestEntityTooLargeException).
429 MessageBody (p. 48) The request failed because
too many requests were sent during a certain amount of time (TooManyRequestsException).
500 MessageBody (p. 48) The request failed due to
an unknown internal server error, exception, or failure (InternalServerErrorException).
Schemas
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
PUT schema
{ "Certificate": "string", "PrivateKey": "string", "Enabled": boolean, "TokenKeyId": "string", "TeamId": "string", "TokenKey": "string", "BundleId": "string",
"DefaultAuthenticationMethod": "string"
}
Response bodies
APNSVoipChannelResponse schema
{ "ApplicationId": "string", "IsArchived": boolean, "Version": integer, "CreationDate": "string", "LastModifiedDate": "string", "LastModifiedBy": "string", "Id": "string",
"Enabled": boolean, "HasCredential": boolean, "Platform": "string", "HasTokenKey": boolean,
Properties
"DefaultAuthenticationMethod": "string"
}
MessageBody schema
{ "RequestID": "string", "Message": "string"
}
Properties
APNSVoipChannelRequest
Specifies the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application.
Certificate
The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate.
Type: string Required: False
PrivateKey
The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.
Type: string Required: False
Enabled
Specifies whether to enable the APNs VoIP channel for the application.
Type: boolean Required: False
TokenKeyId
The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with APNs by using APNs tokens.
Type: string Required: False
TeamId
The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.
Type: string
Properties
Required: False
TokenKey
The authentication key to use for APNs tokens.
Type: string Required: False
BundleId
The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.
Type: string Required: False
DefaultAuthenticationMethod
The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs, key or certificate.
Type: string Required: False
APNSVoipChannelResponse
Provides information about the status and settings of the APNs (Apple Push Notification service) VoIP channel for an application.
ApplicationId
The unique identifier for the application that the APNs VoIP channel applies to.
Type: string Required: False
IsArchived
Specifies whether the APNs VoIP channel is archived.
Type: boolean Required: False
Version
The current version of the APNs VoIP channel.
Type: integer Required: False
CreationDate
The date and time when the APNs VoIP channel was enabled.
Properties
Type: string Required: False
LastModifiedDate
The date and time when the APNs VoIP channel was last modified.
Type: string Required: False
LastModifiedBy
The user who last modified the APNs VoIP channel.
Type: string Required: False
Id
(Deprecated) An identifier for the APNs VoIP channel. This property is retained only for backward compatibility.
Type: string Required: False
Enabled
Specifies whether the APNs VoIP channel is enabled for the application.
Type: boolean Required: False
HasCredential
(Not used) This property is retained only for backward compatibility.
Type: boolean Required: False
Platform
The type of messaging or notification platform for the channel. For the APNs VoIP channel, this value is APNS_VOIP.
Type: string Required: True
HasTokenKey
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.
Type: boolean Required: False
See also
DefaultAuthenticationMethod
The default authentication method that Amazon Pinpoint uses to authenticate with APNs for this channel, key or certificate.
Type: string Required: False
MessageBody
Provides information about an API request or response.
RequestID
The unique identifier for the request or response.
Type: string Required: False
Message
The message that's returned from the API.
Type: string Required: False
See also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following:
GetApnsVoipChannel
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
UpdateApnsVoipChannel
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go