Updated API Protocol (markdown)

liliakai 2014-10-06 12:15:42 -07:00
parent 622fd9974d
commit c108c9be63
1 changed files with 1 additions and 1 deletions

@ -34,7 +34,7 @@ Authorization: Basic {basic_auth}
The client submits the verification code it received via voice or SMS to the server for confirmation. The client submits the verification code it received via voice or SMS to the server for confirmation.
1. `verification_code` is the code it received via voice or SMS, numeric only. 1. `verification_code` is the code it received via voice or SMS, numeric only.
1. `basic_auth` are the authorization credentials the client would like to create. These are in the form of `Base64({number}:{password})`, where `number` is the client's verified PSTN number and `password` is a randomly generated 16 byte string. 1. `basic_auth` are the authorization credentials the client would like to create. These are in the form of `Base64({number}:{password})`, where `number` is the client's verified PSTN number and `password` is a randomly generated 16 byte ASCII string.
1. `signalingKey` is a randomly generated 32 byte AES key and a 20 byte HMAC-SHA1 MAC key, concatenated together and Base64 encoded. 1. `signalingKey` is a randomly generated 32 byte AES key and a 20 byte HMAC-SHA1 MAC key, concatenated together and Base64 encoded.
1. `supportsSms` indicates whether a client supports SMS as a transport. 1. `supportsSms` indicates whether a client supports SMS as a transport.
1. `registrationId` is a 14 bit integer that's randomly generated at client install time. This will be used for clients to detect whether an app has reinstalled and lost their session state. 1. `registrationId` is a 14 bit integer that's randomly generated at client install time. This will be used for clients to detect whether an app has reinstalled and lost their session state.