ListSMSSandboxPhoneNumbers

Gets a list of test phone numbers for the SMS notification channel in the sandbox.

HTTP requestHTTP request

POST https://notifications.yandexcloud.net/

Query parametersQuery parameters

ResponseResponse

Successful responseSuccessful response

If there are no errors, Cloud Notification Service returns the 200 HTTP code.

A successful response contains additional data in XML or JSON format depending on the specified ResponseFormat parameter.

Data schema:

<?xml version="1.0" encoding="UTF-8"?>
<ListSMSSandboxPhoneNumbersResponseXML>
    <ResponseMetadata>
    	<RequestId>string</RequestId>
	</ResponseMetadata>
	<ListSMSSandboxPhoneNumbersResult>
    	<PhoneNumbers>
    		<member>
  	  		<PhoneNumber>string</PhoneNumber>
  	  		<Status>Pending</Status>
  	  	</member>
    	</PhoneNumbers>
    </ListSMSSandboxPhoneNumbersResult>
</ListSMSSandboxPhoneNumbersResponseXML>

{
  "ResponseMetadata": {
    "RequestId": "string"
  },
  "ListSMSSandboxPhoneNumbersResult": {
    "PhoneNumbers": [
      {
        "PhoneNumber": "string",
        "Status": "Pending",
        "IsDeletable": true
      }
    ]
  }
}

Where:

• RequestId: Request ID.
• PhoneNumber: Phone number.
• Status: Number status:
  • Pending: Pending confirmation.
  • Verified: Confirmed.
• IsDeletable: Indicates whether the phone number can be deleted. A test phone number can only be deleted 24 hours after it is added.

Error responseError response

In case of an error, Cloud Notification Service returns a message with the appropriate HTTP code and its additional description in XML or JSON format depending on the specified ResponseFormat parameter.

Data schema:

<?xml version="1.0" encoding="UTF-8"?>
<ErrorResponseXML>
    <RequestId>string</RequestId>
    <Error>
  	  <Code>string</Code>
  	  <Message>string</Message>
    </Error>
</ErrorResponseXML>

{
  "ErrorResponse": {
    "RequestId": "string",
    "Error": {
      "Code": "string",
      "SubCode": "string",
      "Message": "string"
    }
  }
}

Where:

• RequestId: Request ID.
• Code: Error code.
• Message: Error description.

For a list of common error codes for all actions, see Errors.

See alsoSee also

• Yandex Cloud Notification Service HTTP API overview
• Sending an HTTP API request to Yandex Cloud Notification Service
• ListSMSSandboxPhoneNumbers in AWS reference.