Sinch Node.js SDK - v0.0.1
    Preparing search index...

    Sinch Node.js SDK - v0.0.1

    SinchClient

    SinchClient

    Configuration & Utilities

    Region
    VoiceRegion
    ApiFetchClient
    GenericError
    RequestFailedError
    ApiCallParameters
    ApiCallParametersWithPagination
    ApiListPromise
    ApplicationCredentials
    ErrorContext
    PaginatedApiProperties
    ServicePlanIdCredentials
    SinchClientParameters
    UnifiedCredentials
    AutoPaginationMethods
    PageResult
    generateAuthorizationHeader
    getVoiceRegion
    isServicePlanIdCredentials
    isUnifiedCredentials
    validateAuthenticationHeader
    getRegion

    Numbers

    ActiveNumberApi
    AvailableNumberApi
    AvailableRegionsApi
    CallbacksApi
    Numbers
    ActiveNumber
    ActiveNumberRequest
    ActiveNumbersResponse
    AvailableNumber
    AvailableNumbersResponse
    AvailableRegion
    BadRequest
    CallbackConfiguration
    CallbackConfigurationUpdate
    CallbackPayload
    FieldViolation
    GetActiveNumberRequestData
    GetAvailableNumberRequestData
    GetCallbackConfigurationRequestData
    InternalError
    InternalErrorError
    InvalidArgument
    InvalidArgumentError
    ListActiveNumbersRequestData
    ListAvailableNumberRequest
    ListAvailableNumbersRequestData
    ListAvailableRegionsRequestData
    ListAvailableRegionsResponse
    Money
    NotFound
    NotFoundError
    NumberPatternPattern
    NumberPatternSearchPattern
    ReleaseNumberRequestData
    RentAnyNumberRequest
    RentAnyNumberRequestData
    RentAnyNumberRequestSmsConfiguration
    RentAnyNumberRequestVoiceConfiguration
    RentNumberRequest
    RentNumberRequestData
    ScheduledProvisioning
    ScheduledVoiceProvisioning
    SearchPattern
    SMSConfiguration
    UpdateActiveNumberRequestData
    UpdateCallbackConfigurationRequestData
    VoiceConfiguration
    BadRequestTypeEnum
    CallbackPayloadEventTypeEnum
    CallbackPayloadFailureCodeEnum
    CapabilitiesEnum
    InternalErrorErrorCodeEnum
    InternalErrorErrorStatusEnum
    InvalidArgumentErrorCodeEnum
    InvalidArgumentErrorStatusEnum
    NotFoundErrorCodeEnum
    NotFoundErrorStatusEnum
    NumbersCallback
    NumberTypeEnum
    ProvisioningStatus
    RegionNumberTypeEnum
    SearchPatternEnum
    SmsErrorCode
    parseNumbersEventNotification

    SMS

    BatchesApi
    DeliveryReportsApi
    GroupsApi
    InboundsApi
    Sms
    ApiBatchList
    ApiInboundList
    ApiMoMessage
    ApiUpdateBinaryMtMessage
    ApiUpdateMmsMtMessage
    ApiUpdateMtMessage
    ApiUpdateTextMtMessage
    BinaryRequest
    BinaryResponse
    CancelBatchMessageRequestData
    CreateGroupRequest
    CreateGroupRequestData
    CreateGroupResponse
    DeleteGroupRequestData
    DeliveryFeedbackRequest
    DeliveryFeedbackRequestData
    DeliveryReport
    DeliveryReportList
    DryRunRequestData
    DryRunResponse
    DryRunResponsePerRecipientInner
    ErrorResponseObj
    GetBatchMessageRequestData
    GetDeliveryReportByBatchIdRequestData
    GetDeliveryReportByPhoneNumberRequestData
    GetDeliveryReportsRequestData
    GetGroupRequestData
    GetInboundMessageRequestData
    GroupAutoUpdate
    GroupObjectAutoUpdate
    GroupObjectAutoUpdateRemove
    ListBatchesRequestData
    ListGroupsRequestData
    ListGroupsResponse
    ListInboundMessagesRequestData
    ListMembersRequestData
    MediaBody
    MediaRequest
    MediaResponse
    MessageDeliveryStatus
    MOBinary
    MOText
    ParameterObj
    ParameterObjParameterKey
    RecipientDeliveryReport
    ReplaceBatchMessageRequestData
    ReplaceGroupRequest
    ReplaceGroupRequestData
    SendSMSRequestData
    TextRequest
    TextResponse
    UpdateBatchMessageRequestData
    UpdateGroupRequest
    UpdateGroupRequestAutoUpdate
    UpdateGroupRequestAutoUpdateAdd
    UpdateGroupRequestAutoUpdateRemove
    UpdateGroupRequestData
    ApiBatchListBatchesInner
    ApiUpdateBinaryMtMessageTypeEnum
    ApiUpdateMmsMtMessageTypeEnum
    ApiUpdateTextMtMessageTypeEnum
    BinaryRequestTypeEnum
    BinaryResponseTypeEnum
    CancelBatchMessageResponse
    DeliveryReportEnum
    DeliveryReportStatusEnum
    DeliveryReportTypeEnum
    DryRunRequest
    GetDeliveryReportByBatchIdTypeEnum
    InboundMessageResponse
    MediaRequestTypeEnum
    MediaResponseTypeEnum
    MOBinaryTypeEnum
    MOTextTypeEnum
    RecipientDeliveryReportEncodingEnum
    RecipientDeliveryReportTypeEnum
    ReplaceBatchMessageRequest
    ReplaceBatchMessageResponse
    SendSMSRequest
    SendSMSResponse
    SmsCallback
    TextRequestTypeEnum
    TextResponseTypeEnum
    UpdateBatchMessageRequest
    parseSmsEventNotification
    GroupResponse → CreateGroupResponse
    ReplaceGroupResponse → CreateGroupResponse
    UpdateGroupResponse → CreateGroupResponse

    Verification

    Verification
    VerificationsApi
    VerificationStatusApi
    CalloutInitiateVerificationResponse
    CalloutRequestEventResponse
    CalloutRequestEventResponseCallout
    CalloutRequestEventResponseCalloutSpeech
    CalloutVerificationReportRequest
    CalloutVerificationReportRequestCallout
    CalloutVerificationReportResponse
    DataInitiateVerificationResponse
    DataInitiateVerificationResponseSeamless
    FlashCallInitiateVerificationResponse
    FlashCallInitiateVerificationResponseFlashCall
    FlashCallRequestEventResponse
    FlashCallRequestEventResponseFlashCall
    FlashcallVerificationReportRequest
    FlashcallVerificationReportRequestFlashCall
    FlashcallVerificationReportResponse
    FlashcallVerificationReportResponsePrice
    Identity
    InitiateVerificationResource
    InitiateVerificationResourceFlashCallOptions
    LinksObject
    Price
    ReportVerificationByIdentityRequestData
    ReportVerificationByIdRequestData
    SMSInitiateVerificationResponse
    SMSInitiateVerificationResponseSms
    SMSRequestEventResponse
    SMSRequestEventResponseSms
    SmsVerificationReportRequest
    SmsVerificationReportRequestSms
    SMSVerificationReportResponse
    SMSVerificationReportResponsePrice
    StartVerificationRequestData
    VerificationError
    VerificationRequestEvent
    VerificationRequestEventPrice
    VerificationResultEvent
    VerificationStatusByIdentityRequestData
    VerificationStatusByIdRequestData
    VerificationStatusByReferenceRequestData
    CalloutInitiateVerificationResponseMethodEnum
    CalloutRequestEventResponseActionEnum
    CalloutVerificationReportRequestMethodEnum
    CalloutVerificationReportResponseMethodEnum
    CalloutVerificationReportResponseReasonEnum
    DataInitiateVerificationResponseMethodEnum
    FlashCallInitiateVerificationResponseMethodEnum
    FlashCallRequestEventResponseActionEnum
    FlashcallVerificationReportRequestMethodEnum
    FlashcallVerificationReportResponseMethodEnum
    FlashcallVerificationReportResponseReasonEnum
    FlashcallVerificationReportResponseSourceEnum
    IdentityTypeEnum
    InitiateVerificationResourceMethodEnum
    InitiateVerificationResponse
    SMSInitiateVerificationResponseMethodEnum
    SMSRequestEventResponseActionEnum
    SmsVerificationReportRequestMethodEnum
    SMSVerificationReportResponseMethodEnum
    SMSVerificationReportResponseReasonEnum
    SMSVerificationReportResponseSourceEnum
    VerificationCallback
    VerificationReportRequest
    VerificationReportResponse
    VerificationRequestEventMethodEnum
    VerificationRequestEventResponse
    VerificationResponse
    VerificationResultEventMethodEnum
    VerificationResultEventReasonEnum
    VerificationResultEventResponse
    VerificationResultEventSourceEnum
    VerificationStatusEnum
    parseVerificationEventNotification

    Voice

    ApplicationsApi
    CalloutsApi
    CallsApi
    ConferencesApi
    Voice
    AceRequest
    AceRequestAmd
    AceResponse
    AssignNumbers
    AssignNumbersRequestData
    CallHeader
    CalloutRequest
    ConferenceCalloutRequest
    ConferenceCalloutRequestConferenceDtmfOptions
    ConferenceCalloutRequestData
    CustomCalloutRequest
    CustomCalloutRequestData
    Destination
    DiceRequest
    DiceRequestDebit
    DiceRequestUserRate
    GetCallbacks
    GetCallbacksUrl
    GetCallbackURLsRequestData
    GetCalloutResponseObj
    GetCallResponseDebit
    GetCallResponseFrom
    GetCallResponseObj
    GetCallResponseTo
    GetCallResponseUserRate
    GetCallResultRequestData
    GetConferenceInfoRequestData
    GetConferenceInfoResponse
    GetConferenceInfoResponseParticipantsInner
    GetNumbersRequestData
    GetNumbersResponseObj
    GetNumbersResponseObjNumbersInner
    GetQueryNumber
    GetQueryNumberNumberItem
    GetQueryNumberNumberItemRate
    GetRecordingFileInfo
    IceRequest
    IceRequestTo
    IceRequestUserRate
    IceResponse
    KickAllRequestData
    KickParticipantRequestData
    ManageConferenceParticipantRequest
    ManageParticipantRequestData
    ManageWithCallLegRequestData
    NotifyErrorRequest
    NotifyRequest
    Option
    PieRequest
    PieRequestMenuResult
    PieResponse
    QueryNumberRequestData
    StartRecordingOptions
    SvamlActionConnectConf
    SvamlActionConnectConfConferenceDtmfOptions
    SvamlActionConnectMxp
    SvamlActionConnectMxpDestination
    SvamlActionConnectPstn
    SvamlActionConnectPstnAmd
    SvamlActionConnectSip
    SvamlActionConnectSipDestination
    SvamlActionContinue
    SvamlActionHangup
    SvamlActionPark
    SvamlActionRunMenu
    SvamlInstructionAnswer
    SvamlInstructionPlayFiles
    SvamlInstructionSay
    SvamlInstructionSendDtmf
    SvamlInstructionSetCookie
    SvamlInstructionStartRecording
    SvamlInstructionStopRecording
    SVAMLRequestBody
    TranscriptionOptions
    TtsCalloutRequest
    TtsCalloutRequestData
    UnassignNumberRequestData
    UnassignNumbers
    UpdateCallbacks
    UpdateCallbacksUrl
    UpdateCallbackURLsRequestData
    UpdateCallRequestData
    VoiceError
    AceSvamlAction
    CallLegEnum
    CalloutRequestMethodEnum
    DestinationTypeEnum
    GetCallResponseObjDomainEnum
    GetCallResponseObjStatusEnum
    GetNumbersResponseObjNumbersInnerCapabilityEnum
    GetQueryNumberNumberItemNumberTypeEnum
    IceSvamlAction
    ManageConferenceParticipantRequestCommandEnum
    ManageConferenceParticipantRequestMohEnum
    PieSvamlAction
    ReasonEnum
    ResultEnum
    SvamlAction
    SvamlInstruction
    TtsCalloutRequestDomainEnum
    UnassignNumbersCapabilityEnum
    UpdateNumbersCapabilityEnum
    VoiceCallback
    parseVoiceEventNotification

    Settings

    Member Visibility

    On This Page

    SinchClient
    Configuration & Utilities
    Numbers
    ActiveNumberApiAvailableNumberApiAvailableRegionsApiCallbacksApiNumbersActiveNumberActiveNumberRequestActiveNumbersResponseAvailableNumberAvailableNumbersResponseAvailableRegionBadRequestCallbackConfigurationCallbackConfigurationUpdateCallbackPayloadFieldViolationGetActiveNumberRequestDataGetAvailableNumberRequestDataGetCallbackConfigurationRequestDataInternalErrorInternalErrorErrorInvalidArgumentInvalidArgumentErrorListActiveNumbersRequestDataListAvailableNumberRequestListAvailableNumbersRequestDataListAvailableRegionsRequestDataListAvailableRegionsResponseMoneyNotFoundNotFoundErrorNumberPatternPatternNumberPatternSearchPatternReleaseNumberRequestDataRentAnyNumberRequestRentAnyNumberRequestDataRentAnyNumberRequestSmsConfigurationRentAnyNumberRequestVoiceConfigurationRentNumberRequestRentNumberRequestDataScheduledProvisioningScheduledVoiceProvisioningSearchPatternSMSConfigurationUpdateActiveNumberRequestDataUpdateCallbackConfigurationRequestDataVoiceConfigurationBadRequestTypeEnumCallbackPayloadEventTypeEnumCallbackPayloadFailureCodeEnumCapabilitiesEnumInternalErrorErrorCodeEnumInternalErrorErrorStatusEnumInvalidArgumentErrorCodeEnumInvalidArgumentErrorStatusEnumNotFoundErrorCodeEnumNotFoundErrorStatusEnumNumbersCallbackNumberTypeEnumProvisioningStatusRegionNumberTypeEnumSearchPatternEnumSmsErrorCodeparseNumbersEventNotification
    SMS
    BatchesApiDeliveryReportsApiGroupsApiInboundsApiSmsApiBatchListApiInboundListApiMoMessageApiUpdateBinaryMtMessageApiUpdateMmsMtMessageApiUpdateMtMessageApiUpdateTextMtMessageBinaryRequestBinaryResponseCancelBatchMessageRequestDataCreateGroupRequestCreateGroupRequestDataCreateGroupResponseDeleteGroupRequestDataDeliveryFeedbackRequestDeliveryFeedbackRequestDataDeliveryReportDeliveryReportListDryRunRequestDataDryRunResponseDryRunResponsePerRecipientInnerErrorResponseObjGetBatchMessageRequestDataGetDeliveryReportByBatchIdRequestDataGetDeliveryReportByPhoneNumberRequestDataGetDeliveryReportsRequestDataGetGroupRequestDataGetInboundMessageRequestDataGroupAutoUpdateGroupObjectAutoUpdateGroupObjectAutoUpdateRemoveListBatchesRequestDataListGroupsRequestDataListGroupsResponseListInboundMessagesRequestDataListMembersRequestDataMediaBodyMediaRequestMediaResponseMessageDeliveryStatusMOBinaryMOTextParameterObjParameterObjParameterKeyRecipientDeliveryReportReplaceBatchMessageRequestDataReplaceGroupRequestReplaceGroupRequestDataSendSMSRequestDataTextRequestTextResponseUpdateBatchMessageRequestDataUpdateGroupRequestUpdateGroupRequestAutoUpdateUpdateGroupRequestAutoUpdateAddUpdateGroupRequestAutoUpdateRemoveUpdateGroupRequestDataApiBatchListBatchesInnerApiUpdateBinaryMtMessageTypeEnumApiUpdateMmsMtMessageTypeEnumApiUpdateTextMtMessageTypeEnumBinaryRequestTypeEnumBinaryResponseTypeEnumCancelBatchMessageResponseDeliveryReportEnumDeliveryReportStatusEnumDeliveryReportTypeEnumDryRunRequestGetDeliveryReportByBatchIdTypeEnumInboundMessageResponseMediaRequestTypeEnumMediaResponseTypeEnumMOBinaryTypeEnumMOTextTypeEnumRecipientDeliveryReportEncodingEnumRecipientDeliveryReportTypeEnumReplaceBatchMessageRequestReplaceBatchMessageResponseSendSMSRequestSendSMSResponseSmsCallbackTextRequestTypeEnumTextResponseTypeEnumUpdateBatchMessageRequestparseSmsEventNotificationGroupResponseReplaceGroupResponseUpdateGroupResponse
    Verification
    VerificationVerificationsApiVerificationStatusApiCalloutInitiateVerificationResponseCalloutRequestEventResponseCalloutRequestEventResponseCalloutCalloutRequestEventResponseCalloutSpeechCalloutVerificationReportRequestCalloutVerificationReportRequestCalloutCalloutVerificationReportResponseDataInitiateVerificationResponseDataInitiateVerificationResponseSeamlessFlashCallInitiateVerificationResponseFlashCallInitiateVerificationResponseFlashCallFlashCallRequestEventResponseFlashCallRequestEventResponseFlashCallFlashcallVerificationReportRequestFlashcallVerificationReportRequestFlashCallFlashcallVerificationReportResponseFlashcallVerificationReportResponsePriceIdentityInitiateVerificationResourceInitiateVerificationResourceFlashCallOptionsLinksObjectPriceReportVerificationByIdentityRequestDataReportVerificationByIdRequestDataSMSInitiateVerificationResponseSMSInitiateVerificationResponseSmsSMSRequestEventResponseSMSRequestEventResponseSmsSmsVerificationReportRequestSmsVerificationReportRequestSmsSMSVerificationReportResponseSMSVerificationReportResponsePriceStartVerificationRequestDataVerificationErrorVerificationRequestEventVerificationRequestEventPriceVerificationResultEventVerificationStatusByIdentityRequestDataVerificationStatusByIdRequestDataVerificationStatusByReferenceRequestDataCalloutInitiateVerificationResponseMethodEnumCalloutRequestEventResponseActionEnumCalloutVerificationReportRequestMethodEnumCalloutVerificationReportResponseMethodEnumCalloutVerificationReportResponseReasonEnumDataInitiateVerificationResponseMethodEnumFlashCallInitiateVerificationResponseMethodEnumFlashCallRequestEventResponseActionEnumFlashcallVerificationReportRequestMethodEnumFlashcallVerificationReportResponseMethodEnumFlashcallVerificationReportResponseReasonEnumFlashcallVerificationReportResponseSourceEnumIdentityTypeEnumInitiateVerificationResourceMethodEnumInitiateVerificationResponseSMSInitiateVerificationResponseMethodEnumSMSRequestEventResponseActionEnumSmsVerificationReportRequestMethodEnumSMSVerificationReportResponseMethodEnumSMSVerificationReportResponseReasonEnumSMSVerificationReportResponseSourceEnumVerificationCallbackVerificationReportRequestVerificationReportResponseVerificationRequestEventMethodEnumVerificationRequestEventResponseVerificationResponseVerificationResultEventMethodEnumVerificationResultEventReasonEnumVerificationResultEventResponseVerificationResultEventSourceEnumVerificationStatusEnumparseVerificationEventNotification
    Voice
    ApplicationsApiCalloutsApiCallsApiConferencesApiVoiceAceRequestAceRequestAmdAceResponseAssignNumbersAssignNumbersRequestDataCallHeaderCalloutRequestConferenceCalloutRequestConferenceCalloutRequestConferenceDtmfOptionsConferenceCalloutRequestDataCustomCalloutRequestCustomCalloutRequestDataDestinationDiceRequestDiceRequestDebitDiceRequestUserRateGetCallbacksGetCallbacksUrlGetCallbackURLsRequestDataGetCalloutResponseObjGetCallResponseDebitGetCallResponseFromGetCallResponseObjGetCallResponseToGetCallResponseUserRateGetCallResultRequestDataGetConferenceInfoRequestDataGetConferenceInfoResponseGetConferenceInfoResponseParticipantsInnerGetNumbersRequestDataGetNumbersResponseObjGetNumbersResponseObjNumbersInnerGetQueryNumberGetQueryNumberNumberItemGetQueryNumberNumberItemRateGetRecordingFileInfoIceRequestIceRequestToIceRequestUserRateIceResponseKickAllRequestDataKickParticipantRequestDataManageConferenceParticipantRequestManageParticipantRequestDataManageWithCallLegRequestDataMenuNotifyErrorRequestNotifyRequestOptionPieRequestPieRequestMenuResultPieResponseQueryNumberRequestDataStartRecordingOptionsSvamlActionConnectConfSvamlActionConnectConfConferenceDtmfOptionsSvamlActionConnectMxpSvamlActionConnectMxpDestinationSvamlActionConnectPstnSvamlActionConnectPstnAmdSvamlActionConnectSipSvamlActionConnectSipDestinationSvamlActionContinueSvamlActionHangupSvamlActionParkSvamlActionRunMenuSvamlInstructionAnswerSvamlInstructionPlayFilesSvamlInstructionSaySvamlInstructionSendDtmfSvamlInstructionSetCookieSvamlInstructionStartRecordingSvamlInstructionStopRecordingSVAMLRequestBodyTranscriptionOptionsTtsCalloutRequestTtsCalloutRequestDataUnassignNumberRequestDataUnassignNumbersUpdateCallbacksUpdateCallbacksUrlUpdateCallbackURLsRequestDataUpdateCallRequestDataVoiceErrorAceSvamlActionCallLegEnumCalloutRequestMethodEnumDestinationTypeEnumGetCallResponseObjDomainEnumGetCallResponseObjStatusEnumGetNumbersResponseObjNumbersInnerCapabilityEnumGetQueryNumberNumberItemNumberTypeEnumIceSvamlActionManageConferenceParticipantRequestCommandEnumManageConferenceParticipantRequestMohEnumPieSvamlActionReasonEnumResultEnumSvamlActionSvamlInstructionTtsCalloutRequestDomainEnumUnassignNumbersCapabilityEnumUpdateNumbersCapabilityEnumVoiceCallbackparseVoiceEventNotification