Amazon Connect Service

{'ResourceType': {'ANALYTICS_CONNECTOR', 'WHATSAPP_MESSAGING_PHONE_NUMBER'}}

Associates a connect resource to a flow.

See also: AWS API Documentation

Request Syntax

client.associate_flow(
    InstanceId='string',
    ResourceId='string',
    FlowId='string',
    ResourceType='SMS_PHONE_NUMBER'|'INBOUND_EMAIL'|'OUTBOUND_EMAIL'|'ANALYTICS_CONNECTOR'|'WHATSAPP_MESSAGING_PHONE_NUMBER'
)

type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

type ResourceId:

string

param ResourceId:

[REQUIRED]

The identifier of the resource.

• Amazon Web Services End User Messaging SMS phone number ARN when using SMS_PHONE_NUMBER

• Amazon Web Services End User Messaging Social phone number ARN when using WHATSAPP_MESSAGING_PHONE_NUMBER

type FlowId:

string

param FlowId:

[REQUIRED]

The identifier of the flow.

type ResourceType:

string

param ResourceType:

[REQUIRED]

A valid resource type.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

{'ResourceType': {'ANALYTICS_CONNECTOR', 'WHATSAPP_MESSAGING_PHONE_NUMBER'}}

{'FlowAssociationSummaryList': {'ResourceType': {'ANALYTICS_CONNECTOR',
                                                 'WHATSAPP_MESSAGING_PHONE_NUMBER'}}}

Retrieve the flow associations for the given resources.

See also: AWS API Documentation

Request Syntax

client.batch_get_flow_association(
    InstanceId='string',
    ResourceIds=[
        'string',
    ],
    ResourceType='WHATSAPP_MESSAGING_PHONE_NUMBER'|'VOICE_PHONE_NUMBER'|'INBOUND_EMAIL'|'OUTBOUND_EMAIL'|'ANALYTICS_CONNECTOR'
)

type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

type ResourceIds:

list

param ResourceIds:

[REQUIRED]

A list of resource identifiers to retrieve flow associations.

• Amazon Web Services End User Messaging SMS phone number ARN when using SMS_PHONE_NUMBER

• Amazon Web Services End User Messaging Social phone number ARN when using WHATSAPP_MESSAGING_PHONE_NUMBER

• (string) --

type ResourceType:

string

param ResourceType:

The type of resource association.

rtype:

dict

returns:

Response Syntax

{
    'FlowAssociationSummaryList': [
        {
            'ResourceId': 'string',
            'FlowId': 'string',
            'ResourceType': 'WHATSAPP_MESSAGING_PHONE_NUMBER'|'VOICE_PHONE_NUMBER'|'INBOUND_EMAIL'|'OUTBOUND_EMAIL'|'ANALYTICS_CONNECTOR'
        },
    ]
}

Response Structure

• (dict) --

  • FlowAssociationSummaryList (list) --

    Information about flow associations.

    • (dict) --

      Information about flow associations.

      • ResourceId (string) --

        The identifier of the resource.

      • FlowId (string) --

        The identifier of the flow.

      • ResourceType (string) --

        The type of resource association.

{'IntegrationType': {'ANALYTICS_CONNECTOR', 'CALL_TRANSFER_CONNECTOR'}}

Creates an Amazon Web Services resource association with an Amazon Connect instance.

See also: AWS API Documentation

Request Syntax

client.create_integration_association(
    InstanceId='string',
    IntegrationType='EVENT'|'VOICE_ID'|'PINPOINT_APP'|'WISDOM_ASSISTANT'|'WISDOM_KNOWLEDGE_BASE'|'WISDOM_QUICK_RESPONSES'|'Q_MESSAGE_TEMPLATES'|'CASES_DOMAIN'|'APPLICATION'|'FILE_SCANNER'|'SES_IDENTITY'|'ANALYTICS_CONNECTOR'|'CALL_TRANSFER_CONNECTOR',
    IntegrationArn='string',
    SourceApplicationUrl='string',
    SourceApplicationName='string',
    SourceType='SALESFORCE'|'ZENDESK'|'CASES',
    Tags={
        'string': 'string'
    }
)

type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

type IntegrationType:

string

param IntegrationType:

[REQUIRED]

The type of information to be ingested.

type IntegrationArn:

string

param IntegrationArn:

[REQUIRED]

The Amazon Resource Name (ARN) of the integration.

type SourceApplicationUrl:

string

param SourceApplicationUrl:

The URL for the external application. This field is only required for the EVENT integration type.

type SourceApplicationName:

string

param SourceApplicationName:

The name of the external application. This field is only required for the EVENT integration type.

type SourceType:

string

param SourceType:

The type of the data source. This field is only required for the EVENT integration type.

type Tags:

dict

param Tags:

The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

• (string) --

  • (string) --

rtype:

dict

returns:

Response Syntax

{
    'IntegrationAssociationId': 'string',
    'IntegrationAssociationArn': 'string'
}

Response Structure

• (dict) --

  • IntegrationAssociationId (string) --

    The identifier for the integration association.

  • IntegrationAssociationArn (string) --

    The Amazon Resource Name (ARN) for the association.

{'ResourceType': {'ANALYTICS_CONNECTOR', 'WHATSAPP_MESSAGING_PHONE_NUMBER'}}

Disassociates a connect resource from a flow.

See also: AWS API Documentation

Request Syntax

client.disassociate_flow(
    InstanceId='string',
    ResourceId='string',
    ResourceType='SMS_PHONE_NUMBER'|'INBOUND_EMAIL'|'OUTBOUND_EMAIL'|'ANALYTICS_CONNECTOR'|'WHATSAPP_MESSAGING_PHONE_NUMBER'
)

type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

type ResourceId:

string

param ResourceId:

[REQUIRED]

The identifier of the resource.

• Amazon Web Services End User Messaging SMS phone number ARN when using SMS_PHONE_NUMBER

• Amazon Web Services End User Messaging Social phone number ARN when using WHATSAPP_MESSAGING_PHONE_NUMBER

type ResourceType:

string

param ResourceType:

[REQUIRED]

A valid resource type.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

{'ResourceType': {'ANALYTICS_CONNECTOR', 'WHATSAPP_MESSAGING_PHONE_NUMBER'}}

Retrieves the flow associated for a given resource.

See also: AWS API Documentation

Request Syntax

client.get_flow_association(
    InstanceId='string',
    ResourceId='string',
    ResourceType='SMS_PHONE_NUMBER'|'INBOUND_EMAIL'|'OUTBOUND_EMAIL'|'ANALYTICS_CONNECTOR'|'WHATSAPP_MESSAGING_PHONE_NUMBER'
)

type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

type ResourceId:

string

param ResourceId:

[REQUIRED]

The identifier of the resource.

• Amazon Web Services End User Messaging SMS phone number ARN when using SMS_PHONE_NUMBER

• Amazon Web Services End User Messaging Social phone number ARN when using WHATSAPP_MESSAGING_PHONE_NUMBER

type ResourceType:

string

param ResourceType:

[REQUIRED]

A valid resource type.

rtype:

dict

returns:

Response Syntax

{
    'ResourceId': 'string',
    'FlowId': 'string',
    'ResourceType': 'SMS_PHONE_NUMBER'|'INBOUND_EMAIL'|'OUTBOUND_EMAIL'|'ANALYTICS_CONNECTOR'|'WHATSAPP_MESSAGING_PHONE_NUMBER'
}

Response Structure

• (dict) --

  • ResourceId (string) --

    The identifier of the resource.

  • FlowId (string) --

    The identifier of the flow.

  • ResourceType (string) --

    A valid resource type.

{'ResourceType': {'ANALYTICS_CONNECTOR', 'WHATSAPP_MESSAGING_PHONE_NUMBER'}}

{'FlowAssociationSummaryList': {'ResourceType': {'ANALYTICS_CONNECTOR',
                                                 'WHATSAPP_MESSAGING_PHONE_NUMBER'}}}

List the flow association based on the filters.

See also: AWS API Documentation

Request Syntax

client.list_flow_associations(
    InstanceId='string',
    ResourceType='WHATSAPP_MESSAGING_PHONE_NUMBER'|'VOICE_PHONE_NUMBER'|'INBOUND_EMAIL'|'OUTBOUND_EMAIL'|'ANALYTICS_CONNECTOR',
    NextToken='string',
    MaxResults=123
)

type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

type ResourceType:

string

param ResourceType:

A valid resource type.

type NextToken:

string

param NextToken:

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

type MaxResults:

integer

param MaxResults:

The maximum number of results to return per page.

rtype:

dict

returns:

Response Syntax

{
    'FlowAssociationSummaryList': [
        {
            'ResourceId': 'string',
            'FlowId': 'string',
            'ResourceType': 'WHATSAPP_MESSAGING_PHONE_NUMBER'|'VOICE_PHONE_NUMBER'|'INBOUND_EMAIL'|'OUTBOUND_EMAIL'|'ANALYTICS_CONNECTOR'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • FlowAssociationSummaryList (list) --

    Summary of flow associations.

    • (dict) --

      Information about flow associations.

      • ResourceId (string) --

        The identifier of the resource.

      • FlowId (string) --

        The identifier of the flow.

      • ResourceType (string) --

        The type of resource association.

  • NextToken (string) --

    If there are additional results, this is the token for the next set of results.

{'IntegrationType': {'ANALYTICS_CONNECTOR', 'CALL_TRANSFER_CONNECTOR'}}

{'IntegrationAssociationSummaryList': {'IntegrationType': {'ANALYTICS_CONNECTOR',
                                                           'CALL_TRANSFER_CONNECTOR'}}}

Provides summary information about the Amazon Web Services resource associations for the specified Amazon Connect instance.

See also: AWS API Documentation

Request Syntax

client.list_integration_associations(
    InstanceId='string',
    IntegrationType='EVENT'|'VOICE_ID'|'PINPOINT_APP'|'WISDOM_ASSISTANT'|'WISDOM_KNOWLEDGE_BASE'|'WISDOM_QUICK_RESPONSES'|'Q_MESSAGE_TEMPLATES'|'CASES_DOMAIN'|'APPLICATION'|'FILE_SCANNER'|'SES_IDENTITY'|'ANALYTICS_CONNECTOR'|'CALL_TRANSFER_CONNECTOR',
    NextToken='string',
    MaxResults=123,
    IntegrationArn='string'
)

type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

type IntegrationType:

string

param IntegrationType:

The integration type.

type NextToken:

string

param NextToken:

The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.

type MaxResults:

integer

param MaxResults:

The maximum number of results to return per page.

type IntegrationArn:

string

param IntegrationArn:

The Amazon Resource Name (ARN) of the integration.

rtype:

dict

returns:

Response Syntax

{
    'IntegrationAssociationSummaryList': [
        {
            'IntegrationAssociationId': 'string',
            'IntegrationAssociationArn': 'string',
            'InstanceId': 'string',
            'IntegrationType': 'EVENT'|'VOICE_ID'|'PINPOINT_APP'|'WISDOM_ASSISTANT'|'WISDOM_KNOWLEDGE_BASE'|'WISDOM_QUICK_RESPONSES'|'Q_MESSAGE_TEMPLATES'|'CASES_DOMAIN'|'APPLICATION'|'FILE_SCANNER'|'SES_IDENTITY'|'ANALYTICS_CONNECTOR'|'CALL_TRANSFER_CONNECTOR',
            'IntegrationArn': 'string',
            'SourceApplicationUrl': 'string',
            'SourceApplicationName': 'string',
            'SourceType': 'SALESFORCE'|'ZENDESK'|'CASES'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • IntegrationAssociationSummaryList (list) --

    The associations.

    • (dict) --

      Contains summary information about the associated AppIntegrations.

      • IntegrationAssociationId (string) --

        The identifier for the AppIntegration association.

      • IntegrationAssociationArn (string) --

        The Amazon Resource Name (ARN) for the AppIntegration association.

      • InstanceId (string) --

        The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

      • IntegrationType (string) --

        The integration type.

      • IntegrationArn (string) --

        The Amazon Resource Name (ARN) for the AppIntegration.

      • SourceApplicationUrl (string) --

        The URL for the external application.

      • SourceApplicationName (string) --

        The user-provided, friendly name for the external application.

      • SourceType (string) --

        The name of the source.

  • NextToken (string) --

    If there are additional results, this is the token for the next set of results.

{'ContactRecordingType': 'AGENT | IVR | SCREEN'}

When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording whatever recording is selected in the flow configuration: call, screen, or both. If only call recording or only screen recording is enabled, then it would resume.

Voice and screen recordings are supported.

See also: AWS API Documentation

Request Syntax

client.resume_contact_recording(
    InstanceId='string',
    ContactId='string',
    InitialContactId='string',
    ContactRecordingType='AGENT'|'IVR'|'SCREEN'
)

type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

type ContactId:

string

param ContactId:

[REQUIRED]

The identifier of the contact.

type InitialContactId:

string

param InitialContactId:

[REQUIRED]

The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

type ContactRecordingType:

string

param ContactRecordingType:

The type of recording being operated on.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

{'VoiceRecordingConfiguration': {'IvrRecordingTrack': 'ALL'}}

Starts recording the contact:

• If the API is called before the agent joins the call, recording starts when the agent joins the call.

• If the API is called after the agent joins the call, recording starts at the time of the API call.

StartContactRecording is a one-time action. For example, if you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend and resume it, such as when collecting sensitive information (for example, a credit card number), use SuspendContactRecording and ResumeContactRecording.

You can use this API to override the recording behavior configured in the Set recording behavior block.

Only voice recordings are supported at this time.

See also: AWS API Documentation

Request Syntax

client.start_contact_recording(
    InstanceId='string',
    ContactId='string',
    InitialContactId='string',
    VoiceRecordingConfiguration={
        'VoiceRecordingTrack': 'FROM_AGENT'|'TO_AGENT'|'ALL',
        'IvrRecordingTrack': 'ALL'
    }
)

type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

type ContactId:

string

param ContactId:

[REQUIRED]

The identifier of the contact.

type InitialContactId:

string

param InitialContactId:

[REQUIRED]

The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

type VoiceRecordingConfiguration:

dict

param VoiceRecordingConfiguration:

[REQUIRED]

The person being recorded.

• VoiceRecordingTrack (string) --

  Identifies which track is being recorded.

• IvrRecordingTrack (string) --

  Identifies which IVR track is being recorded.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

{'ContactRecordingType': 'AGENT | IVR | SCREEN'}

Stops recording a call when a contact is being recorded. StopContactRecording is a one-time action. If you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend it for sensitive information (for example, to collect a credit card number), and then restart it, use SuspendContactRecording and ResumeContactRecording.

Only voice recordings are supported at this time.

See also: AWS API Documentation

Request Syntax

client.stop_contact_recording(
    InstanceId='string',
    ContactId='string',
    InitialContactId='string',
    ContactRecordingType='AGENT'|'IVR'|'SCREEN'
)

type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

type ContactId:

string

param ContactId:

[REQUIRED]

The identifier of the contact.

type InitialContactId:

string

param InitialContactId:

[REQUIRED]

The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

type ContactRecordingType:

string

param ContactRecordingType:

The type of recording being operated on.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

{'ContactRecordingType': 'AGENT | IVR | SCREEN'}

When a contact is being recorded, this API suspends recording whatever is selected in the flow configuration: call, screen, or both. If only call recording or only screen recording is enabled, then it would be suspended. For example, you might suspend the screen recording while collecting sensitive information, such as a credit card number. Then use ResumeContactRecording to restart recording the screen.

The period of time that the recording is suspended is filled with silence in the final recording.

Voice and screen recordings are supported.

See also: AWS API Documentation

Request Syntax

client.suspend_contact_recording(
    InstanceId='string',
    ContactId='string',
    InitialContactId='string',
    ContactRecordingType='AGENT'|'IVR'|'SCREEN'
)

type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

type ContactId:

string

param ContactId:

[REQUIRED]

The identifier of the contact.

type InitialContactId:

string

param InitialContactId:

[REQUIRED]

The identifier of the contact. This is the identifier of the contact associated with the first interaction with the contact center.

type ContactRecordingType:

string

param ContactRecordingType:

The type of recording being operated on.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --

{'CustomerEndpoint': {'Address': 'string',
                      'Type': 'TELEPHONE_NUMBER | VOIP | CONTACT_FLOW | '
                              'CONNECT_PHONENUMBER_ARN | EMAIL_ADDRESS'},
 'QueueInfo': {'Id': 'string'},
 'SystemEndpoint': {'Address': 'string',
                    'Type': 'TELEPHONE_NUMBER | VOIP | CONTACT_FLOW | '
                            'CONNECT_PHONENUMBER_ARN | EMAIL_ADDRESS'},
 'UserInfo': {'UserId': 'string'}}

This API is in preview release for Amazon Connect and is subject to change.

Adds or updates user-defined contact information associated with the specified contact. At least one field to be updated must be present in the request.

See also: AWS API Documentation

Request Syntax

client.update_contact(
    InstanceId='string',
    ContactId='string',
    Name='string',
    Description='string',
    References={
        'string': {
            'Value': 'string',
            'Type': 'URL'|'ATTACHMENT'|'CONTACT_ANALYSIS'|'NUMBER'|'STRING'|'DATE'|'EMAIL'|'EMAIL_MESSAGE',
            'Status': 'AVAILABLE'|'DELETED'|'APPROVED'|'REJECTED'|'PROCESSING'|'FAILED',
            'Arn': 'string',
            'StatusReason': 'string'
        }
    },
    SegmentAttributes={
        'string': {
            'ValueString': 'string',
            'ValueMap': {
                'string': {'... recursive ...'}
            },
            'ValueInteger': 123
        }
    },
    QueueInfo={
        'Id': 'string'
    },
    UserInfo={
        'UserId': 'string'
    },
    CustomerEndpoint={
        'Type': 'TELEPHONE_NUMBER'|'VOIP'|'CONTACT_FLOW'|'CONNECT_PHONENUMBER_ARN'|'EMAIL_ADDRESS',
        'Address': 'string'
    },
    SystemEndpoint={
        'Type': 'TELEPHONE_NUMBER'|'VOIP'|'CONTACT_FLOW'|'CONNECT_PHONENUMBER_ARN'|'EMAIL_ADDRESS',
        'Address': 'string'
    }
)

type InstanceId:

string

param InstanceId:

[REQUIRED]

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

type ContactId:

string

param ContactId:

[REQUIRED]

The identifier of the contact. This is the identifier of the contact associated with the first interaction with your contact center.

type Name:

string

param Name:

The name of the contact.

type Description:

string

param Description:

The description of the contact.

type References:

dict

param References:

Well-formed data on contact, shown to agents on Contact Control Panel (CCP).

• (string) --

  • (dict) --

    Well-formed data on a contact, used by agents to complete a contact request. You can have up to 4,096 UTF-8 bytes across all references for a contact.

    • Value (string) --

      A valid value for the reference. For example, for a URL reference, a formatted URL that is displayed to an agent in the Contact Control Panel (CCP).

    • Type (string) -- [REQUIRED]

      The type of the reference. DATE must be of type Epoch timestamp.

    • Status (string) --

      Status of the attachment reference type.

    • Arn (string) --

      The Amazon Resource Name (ARN) of the reference

    • StatusReason (string) --

      Relevant details why the reference was not successfully created.

type SegmentAttributes:

dict

param SegmentAttributes:

A set of system defined key-value pairs stored on individual contact segments (unique contact ID) using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.

Attribute keys can include only alphanumeric, -, and _.

This field can be used to show channel subtype, such as connect:Guide.

Currently Contact Expiry is the only segment attribute which can be updated by using the UpdateContact API.

• (string) --

  • (dict) --

    A value for a segment attribute. This is structured as a map where the key is valueString and the value is a string.

    • ValueString (string) --

      The value of a segment attribute.

    • ValueMap (dict) --

      The value of a segment attribute.

      • (string) --

        • (dict) --

          A value for a segment attribute. This is structured as a map where the key is valueString and the value is a string.

    • ValueInteger (integer) --

      The value of a segment attribute.

type QueueInfo:

dict

param QueueInfo:

Information about the queue associated with a contact. This parameter can only be updated for external audio contacts. It is used when you integrate third-party systems with Contact Lens for analytics. For more information, see Amazon Connect Contact Lens integration in the Amazon Connect Administrator Guide.

• Id (string) --

  The identifier of the queue.

type UserInfo:

dict

param UserInfo:

Information about the agent associated with a contact. This parameter can only be updated for external audio contacts. It is used when you integrate third-party systems with Contact Lens for analytics. For more information, see Amazon Connect Contact Lens integration in the Amazon Connect Administrator Guide.

• UserId (string) --

  The user identifier for the contact.

type CustomerEndpoint:

dict

param CustomerEndpoint:

The endpoint of the customer for which the contact was initiated. For external audio contacts, this is usually the end customer's phone number. This value can only be updated for external audio contacts. For more information, see Amazon Connect Contact Lens integration in the Amazon Connect Administrator Guide.

• Type (string) --

  Type of the endpoint.

• Address (string) --

  Address of the endpoint.

type SystemEndpoint:

dict

param SystemEndpoint:

External system endpoint for the contact was initiated. For external audio contacts, this is the phone number of the external system such as the contact center. This value can only be updated for external audio contacts. For more information, see Amazon Connect Contact Lens integration in the Amazon Connect Administrator Guide.

• Type (string) --

  Type of the endpoint.

• Address (string) --

  Address of the endpoint.

rtype:

dict

returns:

Response Syntax

{}

Response Structure

• (dict) --