Skip to main content

List Subscriber Addresses

GET 
/resources/subscribers/:id/addresses

List Subscriber Addresses

Request​

Path Parameters

    id uuidrequired

    Unique ID of a Subscriber Address.

Responses​

The request has succeeded.

Schema

  • Array [

    • data

    object[]

    required

  • Array [

    • id uuidrequired

    Universal Unique Identifier.

    resource_id uuidrequired

    Universal Unique Identifier.

    name stringrequired

    Name of the Subscriber Address.

    Example: reception
    display_name stringrequired

    Display Name of the Subscriber Address.

    Example: Reception
    type stringrequired

    Type of the Subscriber Address.

    Example: room
    cover_url urirequired

    Cover URL of the Subscriber Address.

    Example: https://example.com/cover.webp
    preview_url urirequired

    Preview URL of the Subscriber Address.

    Example: https://example.com/preview.webp

    channels

    object

    required

    video stringrequired

    Video Channel of the Subscriber Address.

    Example: /public/reception?channel=video
    audio stringrequired

    Audio Channel of the Subscriber Address.

    Example: /public/reception?channel=audio
    messaging stringrequired

    Messaging Channel of the Subscriber Address.

    Example: /public/reception?channel=messaging

  • ]

    • links

    object

    required

    self urirequired

    Link of the current page

    Example: https://{space_name}.signalwire.com/api/fabric/resources/external_swml_handlers?page_number=0&page_size=50
    first urirequired

    Link to the first page

    Example: https://{space_name}.signalwire.com/api/fabric/resources/external_swml_handlers?page_number=0&page_size=50
    next urirequired

    Link to the next page

    Example: https://{space_name}.signalwire.com/api/fabric/resources/external_swml_handlers?page_number=1&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca

  • ]