Skip to content

Cloud Voice RPC API

Service: voice.api.enfonica.com

To call this service, we recommend that you use a supported Enfonica client library. If a client library is not available in your language or framework of choice, or if you need to write your own client, use the following information when you make API requests.

Service endpoint

Cloud Voice has the following service endpoint:

  • voice.api.enfonica.com

Service: enfonica.voice.v1beta1.Aliases

CreateAlias
rpc CreateAlias(CreateAliasRequest) returns (Alias)

Creates a alias.

The caller must have voice.aliases.create permission on the project.
DeleteAlias
rpc DeleteAlias(DeleteAliasRequest) returns (google.protobuf.Empty)

Deletes the specified alias.

The caller must have voice.aliases.delete permission on the project.
GetAlias
rpc GetAlias(GetAliasRequest) returns (Alias)

Retrieves a alias identified by the supplied resource name.

The caller must have voice.aliases.get permission on the project.
ListAliases
rpc ListAliases(ListAliasesRequest) returns (ListAliasesResponse)

Lists all Aliases. List returns alias sorted by create_time descending.

The caller must have voice.aliases.list permission on the project.
UpdateAlias
rpc UpdateAlias(UpdateAliasRequest) returns (Alias)

Updates a alias.

The caller must have voice.aliases.update permission on the project.

Service: enfonica.voice.v1beta1.Calls

CreateCall
rpc CreateCall(CreateCallRequest) returns (Call)

Creates a call in the state QUEUED. This will cause an outgoing call to be started.

The caller must have voice.calls.create permission on the project.
GetCall
rpc GetCall(GetCallRequest) returns (Call)

Retrieves a Call identified by the supplied resource name.

The caller must have voice.calls.get permission on the project.
ListCalls
rpc ListCalls(ListCallsRequest) returns (ListCallsResponse)

Lists the Calls of the specified project. List returns Calls sorted by create_time descending.

The caller must have voice.calls.list permission on the project.

Service: enfonica.voice.v1beta1.Faxes

DeleteFax
rpc DeleteFax(DeleteFaxRequest) returns (google.protobuf.Empty)

Deletes a fax.

The caller must have voice.faxes.delete permission on the project.
GetFax
rpc GetFax(GetFaxRequest) returns (Fax)

Retrieves a Fax identified by the supplied resource name.

The caller must have voice.faxes.get permission on the project.
ListFaxes
rpc ListFaxes(ListFaxesRequest) returns (ListFaxesResponse)

Lists the Faxes of the specified project. List returns Faxes sorted by create_time descending.

The caller must have voice.faxes.list permission on the project.

Service: enfonica.voice.v1beta1.Recordings

DeleteRecording
rpc DeleteRecording(DeleteRecordingRequest) returns (Recording)

Deletes a recording.

The caller must have voice.recordings.delete permission on the project.
GetRecording
rpc GetRecording(GetRecordingRequest) returns (Recording)

Retrieves a Recording identified by the supplied resource name.

The caller must have voice.recordings.get permission on the project.
ListRecordings
rpc ListRecordings(ListRecordingsRequest) returns (ListRecordingsResponse)

Lists the Recordings of the specified project. List returns Recordings sorted by create_time descending.

The caller must have voice.recordings.list permission on the project.

Service: enfonica.voice.v1beta1.SipDomains

CreateSipDomain
rpc CreateSipDomain(CreateSipDomainRequest) returns (SipDomain)

Creates a sip domain.

The caller must have voice.sipDomains.create permission on the project.
DeleteSipDomain
rpc DeleteSipDomain(DeleteSipDomainRequest) returns (SipDomain)

Performs a soft-delete of the specified SIP domain.

The caller must have voice.sipDomains.delete permission on the project.
GetSipDomain
rpc GetSipDomain(GetSipDomainRequest) returns (SipDomain)

Retrieves a sip domain identified by the supplied resource name.

The caller must have voice.sipDomains.get permission on the project.
ListSipDomains
rpc ListSipDomains(ListSipDomainsRequest) returns (ListSipDomainsResponse)

Lists all SipDomains. List returns sip domain sorted by create_time descending.

The caller must have voice.sipDomains.list permission on the project.
UpdateSipDomain
rpc UpdateSipDomain(UpdateSipDomainRequest) returns (SipDomain)

Updates a sip domain.

The caller must have voice.sipDomains.update permission on the project.
VerifyTeamsDirectRouting
rpc VerifyTeamsDirectRouting(VerifyTeamsDirectRoutingRequest) returns (VerifyTeamsDirectRoutingResponse)

Verifies the SIP domain with Teams Direct Routing by applying a verification string provided by Office 365.

The caller must have voice.sipDomains.update permission on the project.

Service: enfonica.voice.v1beta1.SipInfoService

GetSipInfo
rpc GetSipInfo(GetSipInfoRequest) returns (SipInfo)

Retrieves SIP information about the specified SIP call. If the call is not a SIP call, throws NOT_FOUND. If the call has not yet completed, throws FAILED_PRECONDITION. If the SIP call was created greater than 30 days ago, returns NOT_FOUND.

The caller must have voice.calls.get permission on the project.

Service: enfonica.voice.v1beta1.Streams

StreamCall
rpc StreamCall(stream StreamCallRequest) returns (stream StreamCallResponse)

Operates a stream which can be bridged to by a call. This allows bi-directional audio to be passed. This method is only available via the gRPC API (not REST). If the stream is not connected to a call within 30 seconds of establishment, this method will fail.

Service: enfonica.voice.v1beta1.Transcriptions

DeleteTranscription
rpc DeleteTranscription(DeleteTranscriptionRequest) returns (google.protobuf.Empty)

Deletes a transcription.

The caller must have voice.transcriptions.delete permission on the project.
GetTranscription
rpc GetTranscription(GetTranscriptionRequest) returns (Transcription)

Retrieves a Transcription identified by the supplied resource name.

The caller must have voice.transcriptions.get permission on the project.
ListTranscriptions
rpc ListTranscriptions(ListTranscriptionsRequest) returns (ListTranscriptionsResponse)

Lists the Transcriptions of the specified project. List returns Transcriptions sorted by create_time descending.

The caller must have voice.transcriptions.list permission on the project.

Service: enfonica.voice.v1beta1.Users

CreateUser
rpc CreateUser(CreateUserRequest) returns (User)

Creates a user.

The caller must have voice.users.create permission on the project.
DeleteUser
rpc DeleteUser(DeleteUserRequest) returns (google.protobuf.Empty)

Deletes the specified user.

The caller must have voice.users.delete permission on the project.
GetUser
rpc GetUser(GetUserRequest) returns (User)

Retrieves a user identified by the supplied resource name.

The caller must have voice.users.get permission on the project.
ListUsers
rpc ListUsers(ListUsersRequest) returns (ListUsersResponse)

Lists all Users. List returns user sorted by create_time descending.

The caller must have voice.users.list permission on the project.
UpdateUser
rpc UpdateUser(UpdateUserRequest) returns (User)

Updates a user.

The caller must have voice.users.update permission on the project.