Method: projects.contacts.sendTestMessage

Allows a contact admin to send a test message to contact to verify that it has been configured correctly.

HTTP request

POST https://essentialcontacts.googleapis.com/v1/{resource=projects/*}/contacts:sendTestMessage

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
resource

string

Required. The name of the resource to send the test message for. All contacts must either be set directly on this resource or inherited from another resource that is an ancestor of this one. Format: organizations/{organization_id}, folders/{folder_id} or projects/{projectId}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "contacts": [
    string
  ],
  "notificationCategory": enum (NotificationCategory)
}
Fields
contacts[]

string

Required. The list of names of the contacts to send a test message to. Format: organizations/{organization_id}/contacts/{contact_id}, folders/{folder_id}/contacts/{contact_id} or projects/{projectId}/contacts/{contact_id}

Authorization requires the following IAM permission on the specified resource contacts:

  • essentialcontacts.contacts.send
notificationCategory

enum (NotificationCategory)

Required. The notification category to send the test message for. All contacts must be subscribed to this category.

Response body

If successful, the response body is an empty JSON object.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.