Skip to content
This repository was archived by the owner on Jan 18, 2020. It is now read-only.

Commit bedbae6

Browse files
authored
Add push credential docs (#143)
1 parent 9d6e8cb commit bedbae6

File tree

2 files changed

+25
-0
lines changed

2 files changed

+25
-0
lines changed

Images/update_push_credential.png

104 KB
Loading

README.md

+25
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
* [Quickstart](#quickstart) - Run the quickstart app
55
* [Access Tokens](#access-tokens) - Using access tokens
66
* [Managing Audio Interruptions](#managing-audio-interruptions) - Managing audio interruptions
7+
* [Managing Push Credentials](#managing-push-credentials) - Managing push credentials
78
* [More Documentation](#more-documentation) - More documentation related to the Voice iOS SDK
89
* [Issues and Support](#issues-and-support) - Filing issues and general support
910

@@ -281,6 +282,30 @@ CXTransaction *transaction = [[CXTransaction alloc] initWithAction:setHeldCallAc
281282
}];
282283
```
283284

285+
## Managing Push Credentials
286+
287+
A push credential is a record for a push notification channel, for iOS this push credential is a push notification channel record for APNS VoIP. Push credentials are managed in the console under [Mobile Push Credentials](https://www.twilio.com/console/voice/sdks/credentials).
288+
289+
Whenever a registration is performed via `TwilioVoice.registerWithAccessToken:deviceToken:completion` in the iOS SDK the `identity` and the `Push Credential SID` provided in the JWT based access token, along with the `device token` are used as a unique address to send APNS VoIP push notifications to this application instance whenever a call is made to reach that `identity`. Using `TwilioVoice.unregisterWithAccessToken:deviceToken:completion` removes the association for that `identity`.
290+
291+
### Updating a Push Credential
292+
293+
If you need to change or update your credentials provided by Apple you can do so by selecting the Push Credential in the [console](https://www.twilio.com/console/voice/sdks/credentials) and adding your new `certificate` and `private key` in the text box provided on the Push Credential page shown below:
294+
295+
<kbd><img height="667px" src="Images/update_push_credential.png"/></kbd>
296+
297+
### Deleting a Push Credential
298+
299+
We **do not recommend that you delete a Push Credential** unless the application that it was created for is no longer being used.
300+
301+
If **your APNS VoIP certificate is expiring soon or has expired you should not delete your Push Credential**, instead you should update the Push Credential by following the `Updating a Push Credential` section.
302+
303+
When a Push Credential is deleted **any associated registrations made with this Push Credential will be deleted**. Future attempts to reach an `identity` that was registered using the Push Credential SID of this deleted push credential **will fail**.
304+
305+
If you are certain you want to delete a Push Credential you can click on `Delete this Credential` on the [console](https://www.twilio.com/console/voice/sdks/credentials) page of the selected Push Credential.
306+
307+
Please ensure that after deleting the Push Credential you remove or replace the Push Credential SID when generating new access tokens.
308+
284309
## More Documentation
285310
You can find more documentation on getting started as well as our latest AppleDoc below:
286311

0 commit comments

Comments
 (0)