OBJECT

PhoneEntity

link GraphQL Schema definition

  • type PhoneEntity {
  • # Tells if the entity instance is protected against delete (Entities that need to
  • # be present in the system at any time). Delete action still may fail if entity is
  • # deletable, due some other additional validations.
  • isDeleteProtected: Boolean!
  • # Unique identifier of entity.
  • id: ID!
  • # Specifies if the entity is considered deleted.
  • isDeleted: Boolean
  • # Last modification time.
  • modified: DateTime
  • # Creation time.
  • created: DateTime
  • # User the phone is assigned to, when the phone belongs to a specific user
  • # (personal calling/SMS line).
  • owner: ClientEntity
  • # Error code recorded for the phone, set on integration failures (e.g. provider
  • # rejected the last send) or when the user disables the integration; empty when
  • # the phone is healthy.
  • errorCode: Int
  • # Name of the entity and its default text representation.
  • name: String!
  • # Id of the assigned user, or empty when the phone is a company-level resource.
  • ownerId: ID
  • # Phone number in E.164 format (e.g. "+12025550123").
  • phoneNumber: String
  • # External caller identifier from the calling provider (e.g. Twilio caller SID).
  • twilioCallerSid: String
  • # Field whose values are strictly defined with an enumeration of values.
  • type: PhoneTypeEnum!
  • # Revision when entity was lastly changed.
  • revision: Int
  • # Email address that incoming text messages to this phone are forwarded to. Empty
  • # when forwarding is not configured.
  • messageForwardingEmail: String
  • # Phone number that incoming calls/SMS to this phone are forwarded to. Empty when
  • # forwarding is not configured.
  • callForwardingPhone: String
  • # False when the user has disabled the calling/SMS integration on this phone
  • # (error_code is set to indicate user disablement); true otherwise.
  • enabled: Boolean!
  • # Checks which permissions current user has on concrete entity instance.
  • #
  • # Arguments
  • # permissions: [Not documented]
  • instancePermissions(permissions: [EntityPermsEnum!]!): [EntityPermsEnum!]!
  • }

link Require by