Updates: Check the release notes for new features and product updates.

Method: messages.batchCreate

Stores message metadata with Verified SMS.

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/messages:batchCreate

The URL uses gRPC Transcoding syntax.

Request body

The request body contains data with the following structure:

JSON representation
{
  "messages": [
    {
      object (Message)
    }
  ]
}
Fields
messages[]

object (Message)

list of messages metadata.

Maximum 10,000 values per API call.

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.

Message

Additional metadata for SMS message and segments.

JSON representation
{
  "hash": string,
  "agentId": string,
  "rateLimitToken": string,
  "postbackData": string
}
Fields
hash

string (bytes format)

Required. Hash values for SMS messages or message segments. Agents are responsible for splitting messages into segments and creating hash values for each segment.

Hashes 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.

agentId

string

Required. The unique identifier of the Verified SMS agent.

agentId must match the identifier of the agent who's public key was used in the computation of the {shared_sender} during hash creation.

rateLimitToken

string (bytes format)

Optional. Rate limit token used to detect data munging.

The rate limiting token is a one-way hashed conversation ID unique to the agent and device.

A base64-encoded string.

postbackData

string (bytes format)

Optional. Payload that the agent receives in an even of successful SMS verification.

Maximum size is 120 bytes.

A base64-encoded string.