/AWS1/CL_CNT=>SEARCHAVAILABLEPHONENUMBERS()
¶
About SearchAvailablePhoneNumbers¶
Searches for available phone numbers that you can claim to your Amazon Connect instance
or traffic distribution group. If the provided TargetArn
is a traffic distribution group, you can call this API in both
Amazon Web Services Regions associated with the traffic distribution group.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_PHONENUMBERCOUNTRYCODE
TYPE /AWS1/CNTPHONENUMCOUNTRYCODE
/AWS1/CNTPHONENUMCOUNTRYCODE
¶
The ISO country code.
IV_PHONENUMBERTYPE
TYPE /AWS1/CNTPHONENUMBERTYPE
/AWS1/CNTPHONENUMBERTYPE
¶
The type of phone number.
Optional arguments:¶
IV_TARGETARN
TYPE /AWS1/CNTARN
/AWS1/CNTARN
¶
The Amazon Resource Name (ARN) for Amazon Connect instances or traffic distribution groups that phone number inbound traffic is routed through. You must enter
InstanceId
orTargetArn
.
IV_INSTANCEID
TYPE /AWS1/CNTINSTANCEID
/AWS1/CNTINSTANCEID
¶
The identifier of the Amazon Connect instance that phone numbers are claimed to. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. You must enter
InstanceId
orTargetArn
.
IV_PHONENUMBERPREFIX
TYPE /AWS1/CNTPHONENUMBERPREFIX
/AWS1/CNTPHONENUMBERPREFIX
¶
The prefix of the phone number. If provided, it must contain
+
as part of the country code.
IV_MAXRESULTS
TYPE /AWS1/CNTMAXRESULT10
/AWS1/CNTMAXRESULT10
¶
The maximum number of results to return per page.
IV_NEXTTOKEN
TYPE /AWS1/CNTLARGENEXTTOKEN
/AWS1/CNTLARGENEXTTOKEN
¶
The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.