Use GetChatappPhoneNumberMetric to query message sending metrics for a phone number - Chat App Message Service - Alibaba Cloud - Chat App Message Service

Queries the message sending volume metrics for a WhatsApp channel phone number.

Operation description

This operation can only query the sending volume metrics for phone numbers on WhatsApp channels.
You can call this operation to query phone number sending volume metrics, or view them in the Channels Management > Manage > Customer Statistics Daily Report page.
Before calling this operation, call the EnableWhatsAppROIMetric operation to enable WhatsApp ROI metric collection. After enabling, at least one day is required before statistics become available. Message sending volume metrics for messages sent before enabling are not collected.
After enabling WhatsApp ROI metric collection, ensure that your channel has successfully sent messages. You can send messages on the Channels Management > Manage > Send Message page, or by calling the SendChatappMessage or SendChatappMassMessage operation.

QPS limit

The single-user QPS limit for this operation is 50 calls per second. Requests that exceed this limit are throttled, which may affect your business. Call this operation as appropriate.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cams:GetChatappPhoneNumberMetric

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
IsvCode	string	No	The ISV verification code, which is used to verify whether the RAM user is authorized by the ISV.	skdi3kksloslikd****
CustSpaceId	string	No	The SpaceId or instance ID of the ISV sub-customer. This is the channel ID, which can be viewed on the Channels Management page.	cams-************
Granularity	string	No	The metric granularity. Valid values: DAILY: collects metrics on a daily basis. HALF_HOUR: collects metrics every half hour.	DAILY
Start	integer	Yes	The query start time. This value is a timestamp in milliseconds.	1756742399000
End	integer	Yes	The query end time. This value is a timestamp in milliseconds.	1758902399000
PhoneNumber	string	No	The business phone number. This is the number used to send messages, which can be viewed on the Channels Management > Manage > WABA Management > Phone Number Management page.	861380000****

Response elements

Element	Type	Description	Example
	object	The response parameters.
AccessDeniedDetail	string	The access denied details.	None
RequestId	string	The request ID.	608F9CCA-B5EB-3D72-8047-B25D6D75BDEC
Message	string	The error message.	None
Data	array<object>	The list of returned data.
	object	The returned data object.
DeliveredCount	integer	The number of delivered messages.	5
Start	integer	The start time of the metric collection period. This value is a timestamp in milliseconds.	1669619491000
PhoneNumber	string	The business phone number.	861380000****
End	integer	The end time of the metric collection period. This value is a timestamp in milliseconds.	1667196043904
Granularity	string	The metric granularity.	DAILY
SentCount	integer	The number of sent messages.	10
Code	string	The request status code. Valid values: OK: The request was successful. For other error codes, see API error codes.	OK

Examples

Success response

JSON format

{
  "AccessDeniedDetail": "None",
  "RequestId": "608F9CCA-B5EB-3D72-8047-B25D6D75BDEC\n",
  "Message": "None",
  "Data": [
    {
      "DeliveredCount": 5,
      "Start": 1669619491000,
      "PhoneNumber": "861380000****",
      "End": 1667196043904,
      "Granularity": "DAILY",
      "SentCount": 10
    }
  ],
  "Code": "OK"
}

Error codes

HTTP status code	Error code	Error message	Description
400	Product.Unsubscript	You have not subscribed to the specified product.	You have not subscribed to the specified product.
400	Ram.PermissionDeny	You are not authorized to perform the operation.
400	System.LimitControl	The system is under flow control.	The system is under flow control.
400	Unknown.ResourceOwnerId	The resource does not belong to the current user.	The resource does not belong to the current user.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.