Stores message hashes with Verified SMS.
This method is deprecated. Use messages.batchCreate
instead.
Send messages over SMS only after you receive a 200 OK
response from this API call. Otherwise, messages may not be appear as verified on user devices.
HTTP request
POST https://verifiedsms.googleapis.com/v1/{name=agents/*}:storeHashes
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
name |
"agents/{agentId}", where {agentId} is the Verified SMS agent identifier. For example, with the ID |
Request body
The request body contains data with the following structure:
JSON representation | |
---|---|
{
"hashes": {
object ( |
Fields | |
---|---|
hashes |
Hash values of the SMS messages. |
publicKey |
Optional. A public key value, with a size of 120 bytes, created with elliptic curve NIST P-384. If the value is set, and it does not match the public key registered on the server for the corresponding agent, the platform returns a A base64-encoded string. |
Response body
If successful, the response body will be empty.
Authorization Scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/verifiedsms
For more information, see the OAuth 2.0 Overview.
Hashes
Hash values of SMS messages or message segments.
JSON representation | |
---|---|
{ "values": [ string ], "rateLimitTokens": [ string ], "suppressVerification": boolean } |
Fields | |
---|---|
values[] |
Hash values for SMS messages or message segments. Agents are responsible for splitting messages into segements and creating hash values for each segment. Maximum 10,000 values per API call. Hash values are calculated with an SHA256-based HMAC key derivation function that includes {shared_secret} and {segment}. {shared_secret} is a computed shared secret based on agent and user keys created using an ECDH algorithm with elliptic curve NIST P-384. Each hash value is 32 bytes. A base64-encoded string. |
rateLimitTokens[] |
Optional. Rate limit tokens used to detect data munging. The number of rate limit tokens should match the number of hash values. The rate limiting token is a one-way hashed conversation ID unique to the agent and device. A base64-encoded string. |
suppressVerification |
Optional. If true, the Messages app doesn't display the verification status for messages matching the corresponding hashes. Only use this parameter to verify that the agent's hashing and configuration is setup correctly prior to launching the agent to all devices. |