GraphQL Repositoriescall

`entities.call`

Read call records with the call repository, and change them with the call mutations. Same records as the REST Calls entity.

6 queries
4 mutations
REST: Calls

Example: first three call recordsGraphQLcURL

query FirstCalls {
  entities {
    call {
      getByCriteria(first: 3, orderBy: [{ modified: Desc }]) {
        totalCount
        edges { node { id modified } }
      }
    }
  }
}

curl 'https://{region}.api.coevera.com/api/v100/app/space/{space_id}/graphql/public' \
  --user "$COEVERA_API_KEY:$COEVERA_API_SECRET" \
  --header 'Content-Type: application/json' \
  --data '{"query":"query FirstCalls { entities { call { getByCriteria(first: 3, orderBy: [{ modified: Desc }]) { totalCount edges { node { id modified } } } } } }"}'

Queries

Fields of entities { call { … } }.

Kind	Field	Returns
QUERY	`getById`(entityId: ID!) Returns the record with the given id, or null when there is none. Deleted records are returned as well.	CallEntity
QUERY	`getByIds`(entityIds: [ID!]!) Returns the records with the given ids; ids without a record are left out. Deleted records are returned as well.	[CallEntity!]!
QUERY	`getAll`(limit: Int, offset: Int, filter: CallFilterInput, orderBy: [CallOrderByInput!], includeDeleted: Boolean) Returns the records that match the filter, paged with limit and offset.	[CallEntity!]!
QUERY	`getByCriteria`(filter: CallFilterInput, orderBy: [CallOrderByInput!], includeDeleted: Boolean, before: String, after: String, first: Int, last: Int) Returns the records that match the filter as a cursor-paginated connection.	CallEntityConnection
QUERY	`getChangedFieldsSinceRevision`(id: UUID!, revision: Int!) Returns the ids of the fields of a record that changed after the given revision. Returns an empty list for entities without change tracking.	[UUID!]!
QUERY	`getBySid`(entitySid: String!) Returns the call with the given call SID assigned by the telephony provider. An error is returned when no such call exists.	CallEntity

Mutations

Kind	Mutation	Does	Returns
MUTATION	`createCall`(input: CreateCallInput!, validationLevel: [ValidationLevel!])	Create one record	CreateCallPayload
MUTATION	`updateCall`(input: UpdateCallInput!, validationLevel: [ValidationLevel!], sessionIdToUpdate: String)	Update fields	UpdateCallPayload
MUTATION	`bulkUpdateCall`(input: [CreateOrUpdateCallInput!]!, deleteInput: [DeleteCallInput!], validationLevel: [ValidationLevel!], rollbackMethod: RollbackMethod, match: MatchingInput)	Create or update many; per-item results	BulkUpdateCallPayload
MUTATION	`deleteCall`(input: DeleteCallInput!)	Soft-delete	DeleteCallPayload

Types

The types this repository uses, each with its fields and their descriptions. Types several repositories share, such as PageInfo and the filter fields, are in the types index.

CallEntity object 34 fields: isDeleteProtected, id, isDeleted, …

Phone call logged in the space, linked to the user who made it and to the contact, account, lead or opportunity it concerns.

Field	Type	Description
`isDeleteProtected`	Boolean!	True when the record is protected against deletion because it must always exist in the space. Deleting a record that is not protected can still fail on other checks. Read-only.
`id`	ID!	Unique identifier of entity.
`isDeleted`	Boolean	Specifies if the entity is considered deleted.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`account`	AccountEntity	Account the call is linked to, when applicable.
`caller`	ClientEntity	User who initiated the call.
`client`	ClientEntity	User the call was made with, when the call was an internal user-to-user call.
`contact`	ContactEntity	Contact the call is linked to, when applicable.
`lead`	LeadEntity	Lead the call is linked to, when the call is associated with a lead.
`oppty`	OpportunityEntity	Opportunity the call is linked to, when the call is associated with an opportunity.
`opptyProductRelation`	OpptyProductRelationEntity	Specific opportunity line-item discussed on the call, when applicable.
`product`	ProductEntity	Product discussed on the call, when applicable.
`accountId`	ID	Id of the linked account.
`callerId`	ID!	Id of the calling user.
`clientId`	ID	Id of the user the call was made with.
`contactId`	ID	Id of the linked contact.
`leadOpptyId`	ID	Id of the linked lead or opportunity, or empty when not linked.
`opptyProductRelationId`	ID	Id of the linked opportunity product line-item.
`phoneNumber`	String	External phone number called or received, in E.164 format.
`productId`	ID	Id of the linked product.
`transcriptionId`	String	External transcription identifier from the calling provider.
`transcriptionLanguage`	String	Language requested for the transcription as a BCP-47 locale tag (e.g. "en-US").
`transcriptionSummary`	String	AI-generated summary of the call transcription.
`twilioCallLogId`	ID!	Id of the call-log record from the calling provider that this call is associated with.
`transcriptionFileId`	UUID	Id of the cloud object holding the transcription payload, when available.
`audioId`	UUID	Id of the cloud object holding the call audio recording, when available.
`twilioCallSid`	String!	External call identifier from the calling provider (e.g. Twilio Call SID).
`audioStatus`	AudioStatus	Recording and transcription status of the call, computed by the server. The only accepted inputs are Uploading on create, to announce that a recording will be uploaded, and NoRecording on update, to mark that the call has no recording.
`instancePermissions`	[EntityPermsEnum!]! (1 args)	Permissions the current user has on this record, out of the requested ones.
`audio`	CloudObjectEntity	Audio recording of the call (MP3 file); empty when none is stored.
`task`	TaskEntity	Task that represents this phone call; empty when there is none.
`transcriptionFile`	CloudObjectEntity	Transcription of the call as a JSON file; empty when none is stored.
`mediaTranscription`	MediaEntity	Recording of this call, with its transcription and summary when available; null when there is none.

CallEntityConnection object pageInfo: PageInfo!, edges: [CallEntityEdge]!, totalCount: Int

Paginated list of Call records.

Field	Type	Description
`pageInfo`	PageInfo!	Pagination data for this connection.
`edges`	[CallEntityEdge]!	Contains the nodes in this connection.
`totalCount`	Int	Total number of items in the connection.

CallEntityEdge object node: CallEntity, cursor: String!

A Relay edge containing a CallEntity and its cursor.

Field	Type	Description
`node`	CallEntity	The item at the end of the edge
`cursor`	String!	A cursor for use in pagination

CallFilterInput input AND, OR, NOT, globalSearchQuery, one condition per field

Filter conditions for Call records. Conditions on different fields are combined with AND; use OR, AND and NOT for other combinations.

Input field	Type	Description
`OR`	[CallFilterInput!]	Matches records that meet at least one of the listed filters.
`AND`	[CallFilterInput!]	Matches records that meet all of the listed filters.
`NOT`	CallFilterInput	Matches records that do not meet this filter.
`globalSearchQuery`	String	Search term matched against the fields that the global search covers for this entity.
`id`	EntityFilterStringField	Unique identifier of entity.
`isDeleted`	Boolean	Specifies if the entity is considered deleted.
`modified`	EntityFilterDateTimeField	Last modification time.
`created`	EntityFilterDateTimeField	Creation time.
`accountId`	EntityFilterStringField	Id of the linked account.
`callerId`	EntityFilterStringField	Id of the calling user.
`clientId`	EntityFilterStringField	Id of the user the call was made with.
`contactId`	EntityFilterStringField	Id of the linked contact.
`leadOpptyId`	EntityFilterStringField	Id of the linked lead or opportunity, or empty when not linked.
`opptyProductRelationId`	EntityFilterStringField	Id of the linked opportunity product line-item.
`phoneNumber`	EntityFilterStringField	External phone number called or received, in E.164 format.
`productId`	EntityFilterStringField	Id of the linked product.
`transcriptionId`	EntityFilterStringField	External transcription identifier from the calling provider.
`transcriptionLanguage`	EntityFilterStringField	Language requested for the transcription as a BCP-47 locale tag (e.g. "en-US").
`transcriptionSummary`	EntityFilterStringField	AI-generated summary of the call transcription.
`twilioCallLogId`	EntityFilterStringField	Id of the call-log record from the calling provider that this call is associated with.
`account`	AccountFilterInput	Account the call is linked to, when applicable. Matches records where a related record meets these conditions.
`caller`	ClientFilterInput	User who initiated the call. Matches records where a related record meets these conditions.
`client`	ClientFilterInput	User the call was made with, when the call was an internal user-to-user call. Matches records where a related record meets these conditions.
`contact`	ContactFilterInput	Contact the call is linked to, when applicable. Matches records where a related record meets these conditions.
`lead`	LeadFilterInput	Lead the call is linked to, when the call is associated with a lead. Matches records where a related record meets these conditions.
`oppty`	OpportunityFilterInput	Opportunity the call is linked to, when the call is associated with an opportunity. Matches records where a related record meets these conditions.
`opptyProductRelation`	OpptyProductRelationFilterInput	Specific opportunity line-item discussed on the call, when applicable. Matches records where a related record meets these conditions.
`product`	ProductFilterInput	Product discussed on the call, when applicable. Matches records where a related record meets these conditions.

CallOrderByInput input Asc or Desc per field

Sorting of Call records. Set exactly one field in each item; list several items to sort by more fields, in order of priority.

Input field	Type	Description
`id`	OrderByEnum	Unique identifier of entity.
`isDeleted`	OrderByEnum	Specifies if the entity is considered deleted.
`modified`	OrderByEnum	Last modification time.
`created`	OrderByEnum	Creation time.
`account`	[AccountOrderByNestedInput!]	Account the call is linked to, when applicable. Sorts by fields of the related record, listed in order of priority.
`caller`	[ClientOrderByNestedInput!]	User who initiated the call. Sorts by fields of the related record, listed in order of priority.
`client`	[ClientOrderByNestedInput!]	User the call was made with, when the call was an internal user-to-user call. Sorts by fields of the related record, listed in order of priority.
`contact`	[ContactOrderByNestedInput!]	Contact the call is linked to, when applicable. Sorts by fields of the related record, listed in order of priority.
`lead`	[LeadOrderByNestedInput!]	Lead the call is linked to, when the call is associated with a lead. Sorts by fields of the related record, listed in order of priority.
`oppty`	[OpportunityOrderByNestedInput!]	Opportunity the call is linked to, when the call is associated with an opportunity. Sorts by fields of the related record, listed in order of priority.
`opptyProductRelation`	[OpptyProductRelationOrderByNestedInput!]	Specific opportunity line-item discussed on the call, when applicable. Sorts by fields of the related record, listed in order of priority.
`product`	[ProductOrderByNestedInput!]	Product discussed on the call, when applicable. Sorts by fields of the related record, listed in order of priority.
`accountId`	OrderByEnum	Id of the linked account.
`callerId`	OrderByEnum	Id of the calling user.
`clientId`	OrderByEnum	Id of the user the call was made with.
`contactId`	OrderByEnum	Id of the linked contact.
`leadOpptyId`	OrderByEnum	Id of the linked lead or opportunity, or empty when not linked.
`opptyProductRelationId`	OrderByEnum	Id of the linked opportunity product line-item.
`phoneNumber`	OrderByEnum	External phone number called or received, in E.164 format.
`productId`	OrderByEnum	Id of the linked product.
`transcriptionId`	OrderByEnum	External transcription identifier from the calling provider.
`transcriptionLanguage`	OrderByEnum	Language requested for the transcription as a BCP-47 locale tag (e.g. "en-US").
`transcriptionSummary`	OrderByEnum	AI-generated summary of the call transcription.

CreateCallInput input 17 fields: clientMutationId, modified, created, …

Field values of a new Call record.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`opptyProductRelation`	CreateOpptyProductRelationInput	Specific opportunity line-item discussed on the call, when applicable.
`accountId`	ID	Id of the linked account.
`callerId`	ID!	Id of the calling user.
`clientId`	ID	Id of the user the call was made with.
`contactId`	ID	Id of the linked contact.
`leadOpptyId`	ID	Id of the linked lead or opportunity, or empty when not linked.
`opptyProductRelationId`	ID	Id of the linked opportunity product line-item.
`phoneNumber`	String	External phone number called or received, in E.164 format.
`productId`	ID	Id of the linked product.
`transcriptionId`	String	External transcription identifier from the calling provider.
`transcriptionLanguage`	String	Language requested for the transcription as a BCP-47 locale tag (e.g. "en-US").
`transcriptionSummary`	String	AI-generated summary of the call transcription.
`twilioCallLogId`	ID!	Id of the call-log record from the calling provider that this call is associated with.
`audioStatus`	AudioStatus	Recording and transcription status of the call, computed by the server. The only accepted inputs are Uploading on create, to announce that a recording will be uploaded, and NoRecording on update, to mark that the call has no recording.

CreateOrUpdateCallInput input 18 fields: clientMutationId, id, modified, …

Field values of a Call record to create, or to update when its id is set.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`id`	ID	Unique identifier of entity.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`opptyProductRelation`	CreateOpptyProductRelationInput	Specific opportunity line-item discussed on the call, when applicable.
`accountId`	ID	Id of the linked account.
`callerId`	ID	Id of the calling user.
`clientId`	ID	Id of the user the call was made with.
`contactId`	ID	Id of the linked contact.
`leadOpptyId`	ID	Id of the linked lead or opportunity, or empty when not linked.
`opptyProductRelationId`	ID	Id of the linked opportunity product line-item.
`phoneNumber`	String	External phone number called or received, in E.164 format.
`productId`	ID	Id of the linked product.
`transcriptionId`	String	External transcription identifier from the calling provider.
`transcriptionLanguage`	String	Language requested for the transcription as a BCP-47 locale tag (e.g. "en-US").
`transcriptionSummary`	String	AI-generated summary of the call transcription.
`twilioCallLogId`	ID	Id of the call-log record from the calling provider that this call is associated with.
`audioStatus`	AudioStatus	Recording and transcription status of the call, computed by the server. The only accepted inputs are Uploading on create, to announce that a recording will be uploaded, and NoRecording on update, to mark that the call has no recording.

DeleteCallInput input clientMutationId: String, id: ID!, leadOpptyId: ID

Id of the Call record to delete.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`id`	ID!	Unique identifier of entity.
`leadOpptyId`	ID	Id of the linked lead or opportunity, or empty when not linked.

UpdateCallInput input 18 fields: clientMutationId, id, modified, …

Id of a Call record and the field values to change.

Input field	Type	Description
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).
`id`	ID!	Unique identifier of entity.
`modified`	DateTime	Last modification time.
`created`	DateTime	Creation time.
`opptyProductRelation`	CreateOpptyProductRelationInput	Specific opportunity line-item discussed on the call, when applicable.
`accountId`	ID	Id of the linked account.
`callerId`	ID	Id of the calling user.
`clientId`	ID	Id of the user the call was made with.
`contactId`	ID	Id of the linked contact.
`leadOpptyId`	ID	Id of the linked lead or opportunity, or empty when not linked.
`opptyProductRelationId`	ID	Id of the linked opportunity product line-item.
`phoneNumber`	String	External phone number called or received, in E.164 format.
`productId`	ID	Id of the linked product.
`transcriptionId`	String	External transcription identifier from the calling provider.
`transcriptionLanguage`	String	Language requested for the transcription as a BCP-47 locale tag (e.g. "en-US").
`transcriptionSummary`	String	AI-generated summary of the call transcription.
`twilioCallLogId`	ID	Id of the call-log record from the calling provider that this call is associated with.
`audioStatus`	AudioStatus	Recording and transcription status of the call, computed by the server. The only accepted inputs are Uploading on create, to announce that a recording will be uploaded, and NoRecording on update, to mark that the call has no recording.

BulkUpdateCallPayload object result: BulkUpdateResults!

Result of the bulkUpdateCall mutation.

Field	Type	Description
`result`	BulkUpdateResults!	Ids of the created, updated and deleted records, and the items that failed.

CreateCallPayload object call: CallEntity, clientMutationId: String

Result of the createCall mutation.

Field	Type	Description
`call`	CallEntity	The created record.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

DeleteCallPayload object call: CallEntity, clientMutationId: String

Result of the deleteCall mutation.

Field	Type	Description
`call`	CallEntity	The deleted record.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

UpdateCallPayload object call: CallEntity, clientMutationId: String

Result of the updateCall mutation.

Field	Type	Description
`call`	CallEntity	The updated record.
`clientMutationId`	String	Optional client-supplied identifier passed on a mutation input and echoed back unchanged on its payload, so a client can correlate the response with its request (Relay convention).

AudioStatus enum NoRecording, Uploading, Uploaded, TranscriptionInProgress, TranscriptionError, TranscriptionCompleted, UploadError, TranscriptionEmpty

Recording and transcription status of a call.

Value	Description
`NoRecording`	The call has no recording.
`Uploading`	The recording is not available yet.
`Uploaded`	The recording is available; no transcription is in progress.
`TranscriptionInProgress`	The recording is being transcribed.
`TranscriptionError`	Transcription of the recording failed.
`TranscriptionCompleted`	The transcription is available.
`UploadError`	A transcription was requested but the recording could not be obtained.
`TranscriptionEmpty`	The recording contained nothing to transcribe, for example because the call was too short.