UPDATEPHONENUMBER()`¶

About UpdatePhoneNumber¶

Updates your claimed phone number from its current Amazon Connect instance or traffic distribution group to another Amazon Connect instance or traffic distribution group in the same Amazon Web Services Region.

After using this API, you must verify that the phone number is attached to the correct flow in the target instance or traffic distribution group. You need to do this because the API switches only the phone number to a new instance or traffic distribution group. It doesn't migrate the flow configuration of the phone number, too.

You can call DescribePhoneNumber API to verify the status of a previous UpdatePhoneNumber operation.

Method Signature¶

METHODS /AWS1/IF_CNT~UPDATEPHONENUMBER
  IMPORTING
    !IV_PHONENUMBERID TYPE /AWS1/CNTPHONENUMBERID OPTIONAL
    !IV_TARGETARN TYPE /AWS1/CNTARN OPTIONAL
    !IV_INSTANCEID TYPE /AWS1/CNTINSTANCEID OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/CNTCLIENTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cntupdphonenumberrsp
  RAISING
    /AWS1/CX_CNTACCESSDENIEDEX
    /AWS1/CX_CNTIDEMPOTENCYEX
    /AWS1/CX_CNTINTERNALSERVICEEX
    /AWS1/CX_CNTINVALIDPARAMETEREX
    /AWS1/CX_CNTRESOURCEINUSEEX
    /AWS1/CX_CNTRESOURCENOTFOUNDEX
    /AWS1/CX_CNTTHROTTLINGEX
    /AWS1/CX_CNTCLIENTEXC
    /AWS1/CX_CNTSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_phonenumberid` `TYPE /AWS1/CNTPHONENUMBERID` `/AWS1/CNTPHONENUMBERID`¶

A unique identifier for the 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 or TargetArn.

`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 or TargetArn.

`iv_clienttoken` `TYPE /AWS1/CNTCLIENTTOKEN` `/AWS1/CNTCLIENTTOKEN`¶

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_cntupdphonenumberrsp` `/AWS1/CL_CNTUPDPHONENUMBERRSP`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->updatephonenumber(
  iv_clienttoken = |string|
  iv_instanceid = |string|
  iv_phonenumberid = |string|
  iv_targetarn = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_phonenumberid = lo_result->get_phonenumberid( ).
  lv_arn = lo_result->get_phonenumberarn( ).
ENDIF.

/AWS1/IF_CNT=>UPDATEPHONENUMBER()¶