Click here to load reader

Cisco Unity Connection DraftCisco Unity Connection Draft Author Unknown Created Date 1/2/2019 3:52:04 AM

  • View
    2

  • Download
    0

Embed Size (px)

Text of Cisco Unity Connection DraftCisco Unity Connection Draft Author Unknown Created Date 1/2/2019...

  • Cisco Unity Connection DraftAmericas HeadquartersCisco Systems, Inc.170 West Tasman DriveSan Jose, CA 95134-1706USAhttp://www.cisco.comTel: 408 526-4000

    800 553-NETS (6387)Fax: 408 527-0883

  • © 2018 Cisco Systems, Inc. All rights reserved.

  • C O N T E N T S

    Cisco Unity Connection API List 1C H A P T E R 1

    Draft 1

    Cisco Unity Connection API List Examples 3C H A P T E R 2

    Cisco Unity Connection API List Examples 3

    Cisco Unity Connection Draftiii

  • Cisco Unity Connection Draftiv

    Contents

  • C H A P T E R 1Cisco Unity Connection API List

    • Draft, on page 1

    DraftTable 1: /vmrest/version

    Use this API to retrieve the current version of thesystem.

    Description:

    https://:/vmrest/versionAPI URI:

    XMLSupported Response Formats:

    GETHTTP Method:

    NoneRequest Parameters:

    NoneHeader Parameters:

    NoneParameter Description:

    https://10.10.10.10:8443/vmrest/schema/VersionInformationSchema:

    NoneFailure Response Schema:

    See API Response Codes.Related Error Codes:

    NoneEvents Triggered:

    8.5(1)Release:

    Cisco Unity Connection API List ExamplesNotes or Examples:

    Table 2: /vmrest/distributionlists

    Use this API to work with distribution lists.Description:

    https://:/vmrest/distributionlistsAPI URI:

    XMLSupported Response Formats:

    GET,POST,PUT,DELETEHTTP Method:

    Cisco Unity Connection Draft1

  • query, sort, pageNumber, rowsPerPage, propertiesRequest Parameters:

    NoneHeader Parameters:

    NoneParameter Description:

    https://10.10.10.10:8443/vmrest/schema/DistributionListSchema:

    NoneFailure Response Schema:

    See API Response Codes.Related Error Codes:

    NoneEvents Triggered:

    8.5(1)Release:

    Cisco Unity Connection API List ExamplesNotes or Examples:

    Table 3: /vmrest/distributionlists/{objectid}/distributionlistmembers

    Use this API to work with distribution lists.Description:

    https://:/vmrest/distributionlists/{objectid}/distributionlistmembersAPI URI:

    XMLSupported Response Formats:

    GET,POST,PUT,DELETEHTTP Method:

    query, sort, pageNumber, rowsPerPage, propertiesRequest Parameters:

    NoneHeader Parameters:

    NoneParameter Description:

    https://10.10.10.10:8443/vmrest/schema/DistributionListMemberSchema:

    NoneFailure Response Schema:

    See API Response CodesRelated Error Codes:

    NoneEvents Triggered:

    8.5(1)Release:

    Cisco Unity Connection API List ExamplesNotes or Examples:

    Cisco Unity Connection Draft2

    Cisco Unity Connection API ListDraft

  • C H A P T E R 2Cisco Unity Connection API List Examples

    • Cisco Unity Connection API List Examples, on page 3

    Cisco Unity Connection API List ExamplesExamples for /vmrest/version

    Example 1: GET

    HTTP GET:

    https://10.10.10.10:8443/vmrest/version

    HTTP RESPONSE:

    vmrest8.6.2.0ES3

    Examples for /vmrest/distributionlist

    Example 1: GET

    HTTP GET:

    https://10.10.10.10:8443/vmrest/distributionlists

    HTTP RESPONSE:

    Cisco Unity Connection Draft3

  • /vmrest/distributionlists/92fa35cc-a72e-4f59-83e5-ccf6fce07f1e92fa35cc-a72e-4f59-83e5-ccf6fce07f1eundeliverablemessagesUndeliverable Messages3b05f7ec-2398-4e43-b23c-03535ab9afc9

    /vmrest/locations/connectionlocations/3b05f7ec-2398-4e43-b23c-03535ab9afc9

    e886836c-f61b-4bc2-ba37-12d06b446abd/vmrest/partitions/e886836c-f61b-4bc2-ba37-12d06b446abd

    /vmrest/distributionlists/92fa35cc-a72e-4f59-83e5-ccf6fce07f1e/distributionlistmembers

    /vmrest/alternatenames?query=(DistributionListObjectId%20is%2092fa35cc-a72e-4f59-83e5-ccf6fce07f1e)

    /vmrest/distributionlists/24f444c9-34ce-4072-9270-672933c7bb3a24f444c9-34ce-4072-9270-672933c7bb3aallvoicemailusersAll Voice Mail Users3b05f7ec-2398-4e43-b23c-03535ab9afc9

    /vmrest/locations/connectionlocations/3b05f7ec-2398-4e43-b23c-03535ab9afc9

    99991e886836c-f61b-4bc2-ba37-12d06b446abd/vmrest/partitions/e886836c-f61b-4bc2-ba37-12d06b446abd

    /vmrest/distributionlists/24f444c9-34ce-4072-9270-672933c7bb3a/distributionlistmembers

    /vmrest/alternatenames?query=(DistributionListObjectId%20is%2024f444c9-34ce-4072-9270-672933c7bb3a)

    Example 2: GET

    HTTP GET:

    https://10.10.10.10:8443/vmrest/distributionlists?query=(alias startswith F)&sort=(aliasdesc)

    HTTP RESPONSE:

    Cisco Unity Connection Draft4

    Cisco Unity Connection API List ExamplesCisco Unity Connection API List Examples

  • /vmrest/distributionlists/de9cb6c5-873c-454b-8fd3-58b7aaf62dd0de9cb6c5-873c-454b-8fd3-58b7aaf62dd0FSTDK02FSTDK023b05f7ec-2398-4e43-b23c-03535ab9afc9

    /vmrest/locations/connectionlocations/3b05f7ec-2398-4e43-b23c-03535ab9afc9

    4445e886836c-f61b-4bc2-ba37-12d06b446abd/vmrest/partitions/e886836c-f61b-4bc2-ba37-12d06b446abd

    /vmrest/distributionlists/de9cb6c5-873c-454b-8fd3-58b7aaf62dd0/distributionlistmembers

    /vmrest/alternatenames?query=(DistributionListObjectId%20is%20de9cb6c5-873c-454b-8fd3-58b7aaf62dd0)

    /vmrest/distributionlists/d3e0c786-0be4-4b72-a27b-c745d1504180d3e0c786-0be4-4b72-a27b-c745d1504180FSTDK01FSTDK013b05f7ec-2398-4e43-b23c-03535ab9afc9

    /vmrest/locations/connectionlocations/3b05f7ec-2398-4e43-b23c-03535ab9afc9

    4444e886836c-f61b-4bc2-ba37-12d06b446abd/vmrest/partitions/e886836c-f61b-4bc2-ba37-12d06b446abd

    /vmrest/distributionlists/d3e0c786-0be4-4b72-a27b-c745d1504180/distributionlistmembers

    /vmrest/alternatenames?query=(DistributionListObjectId%20is%20d3e0c786-0be4-4b72-a27b-c745d1504180)

    Example 3: POST

    HTTP POST:

    https://10.10.10.10:8443/vmrest/distributionlists

    HTTP BODY:

    FSTDK03FSTDK034446

    HTTP RESPONSE:

    /vmrest/distributionlists/5f038b49-5840-4974-b555-fadfaa327024

    Example 4: PUT

    HTTP PUT:

    Cisco Unity Connection Draft5

    Cisco Unity Connection API List ExamplesCisco Unity Connection API List Examples

  • https://10.10.10.10:8443/vmrest/distributionlists/{objectid}

    HTTP BODY:

    4447

    HTTP RESPONSE:

    {empty response} Return Code = HTTP/1.1 204 No Content

    Cisco Unity Connection Draft6

    Cisco Unity Connection API List ExamplesCisco Unity Connection API List Examples

    Cisco Unity Connection DraftContentsCisco Unity Connection API ListDraft

    Cisco Unity Connection API List ExamplesCisco Unity Connection API List Examples