REST Resource: projects.phoneNumbers

Resource: PhoneNumber

Represents a phone number. PhoneNumber resources enable phone calls to be answered by Dialogflow services and are added to a project through a PhoneNumberOrder .

JSON representation
 { 
 "name" 
 : 
 string 
 , 
 "phoneNumber" 
 : 
 string 
 , 
 "conversationProfile" 
 : 
 string 
 , 
 "lifecycleState" 
 : 
 enum (  LifecycleState 
 
) 
 } 
Fields
name

string

Optional. The unique identifier of this phone number. Required for PhoneNumbers.UpdatePhoneNumber method. Format: projects/<Project ID>/phoneNumbers/<PhoneNumber ID> . Format: projects/<Project ID>/locations/<Location ID>/phoneNumbers/<PhoneNumber ID> .

phoneNumber

string

Output only. Phone number in E.164 format. An example of a correctly formatted phone number: +15556767888.

conversationProfile

string

Optional. The conversation profile calls to this PhoneNumber should use. The project ID here should be the same as the one in name . Format: projects/<Project ID>/conversationProfiles/<ConversationProfile ID> . Format: projects/<Project ID>/locations/<Location ID>/conversationProfiles/<ConversationProfile ID> .

lifecycleState

enum ( LifecycleState )

Output only. The state of the PhoneNumber . Defaults to ACTIVE . PhoneNumber objects set to DELETE_REQUESTED always decline incoming calls and can be removed completely within 30 days.

LifecycleState

The states that a PhoneNumber can be in.

Enums
LIFECYCLE_STATE_UNSPECIFIED This value is never used.
ACTIVE Number is active and can receive phone calls.
DELETE_REQUESTED Number is pending deletion, and cannot receive calls.

Methods

delete

Requests deletion of a PhoneNumber .

list

Returns the list of all phone numbers in the specified project.

patch

Updates the specified PhoneNumber .

undelete

Cancels the deletion request for a PhoneNumber .
Design a Mobile Site
View Site in Mobile | Classic
Share by: