room

Direct dial-in (SIP bridge)

Required capability: sip-direct-dialin

post/ocs/v2.php/apps/spreed/api/{apiVersion}/room/direct-dial-in

Path parameters

apiVersion'v4' required

Headers

talk-sipbridge-randomstring

Random seed (at least 32 bytes) used together with the phone number to generate the SHA256-HMAC request checksum

talk-sipbridge-checksumstring

SHA256-HMAC checksum over the concatenation of the random seed and the phone number, signed with the shared SIP bridge secret, to verify authenticity from the SIP bridge

OCS-APIRequestboolean required

Required to be true for the API request to pass

Request body

phoneNumberstring required

Phone number that is called

callerstring required

Phone number of the person calling in

Response

Call conversation created

Changes

Changed in 17 of the 54 revisions of this API.224

    • added the required property ocs/data/tagIds to the response with the 200 status

      response-required-property-added

    • added the optional property ocs/data/lastMessage/anyOf[ChatMessage]/allOf[subschema #2]/metaData/replyToActorDisplayName to the response with the 200 status

      response-optional-property-added

    • added the optional property ocs/data/lastMessage/anyOf[ChatMessage]/allOf[subschema #2]/metaData/replyToConversationName to the response with the 200 status

      response-optional-property-added

    • added the optional property ocs/data/lastMessage/anyOf[ChatMessage]/allOf[subschema #2]/metaData/replyToConversationToken to the response with the 200 status

      response-optional-property-added

    • added the optional property ocs/data/lastMessage/anyOf[ChatMessage]/allOf[subschema #2]/metaData/replyToMessageId to the response with the 200 status

      response-optional-property-added

    • added the required property ocs/data/attributes to the response with the 200 status

      response-required-property-added

    • added the optional property ocs/data/lastMessage/anyOf[ChatMessage]/allOf[subschema #2]/metaData/threadId to the response with the 200 status

      response-optional-property-added

    • added the optional property ocs/data/lastMessage/anyOf[ChatMessage]/allOf[subschema #2]/metaData/threadTitle to the response with the 200 status

      response-optional-property-added

    • the ocs/data/hasScheduledMessages response's property type/format changed from boolean/ to integer/int64 for status 200

      response-property-type-changed

    • added the required property ocs/data/hasScheduledMessages to the response with the 200 status

      response-required-property-added

    • added the optional property ocs/data/lastMessage/anyOf[ChatMessage]/allOf[subschema #2]/metaData/pinnedAt to the response with the 200 status

      response-optional-property-added

    • added the optional property ocs/data/lastMessage/anyOf[ChatMessage]/allOf[subschema #2]/metaData to the response with the 200 status

      response-optional-property-added

    • added the required property ocs/data/hiddenPinnedId to the response with the 200 status

      response-required-property-added

    • added the required property ocs/data/lastPinnedId to the response with the 200 status

      response-required-property-added

    • added the optional property ocs/data/lastMessage/anyOf[ChatMessage]/allOf[subschema #2]/threadReplies to the response with the 200 status

      response-optional-property-added

    • added the optional property ocs/data/lastMessage/anyOf[ChatMessage]/allOf[subschema #2]/threadTitle to the response with the 200 status

      response-optional-property-added

    • added the required property ocs/data/liveTranscriptionLanguageId to the response with the 200 status

      response-required-property-added