SIGN UP
Navigation

Managing Skills

Methods

Adds a new ACD operator skill.

Parameters

  • Follow link for authentication parameter names and details.

  • skill_name:

    string

    The ACD operator skill name. The length must be less than 512.

Returns

  • result:

    number

    1

  • skill_id:

    number

    The skill ID

Examples

request:

Add a new skill.

https://api.voximplant.com/platform_api/AddSkill/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&skill_name=English

response:

Success.

{
    "result": 1,
    "skill_id": 1
}

Binds the skills with the users (ACD operators) and/or the ACD queues.

Parameters

  • Follow link for authentication parameter names and details.

  • skill_id:

    string

    The skill ID list separated by the ';' symbol or the 'all' value.

  • skill_name:

    string

    Can be used instead of skill_id. The skill name list separated by the ';' symbol.

  • user_id:

    string

    The user ID list separated by the ';' symbol or the 'all' value.

  • user_name:

    string

    The user name that can be used instead of user_id. The user name list separated by the ';' symbol.

  • acd_queue_id:

    string

    The ACD queue ID list separated by the ';' symbol or the 'all' value.

  • acd_queue_name:

    string

    The ACD queue name that can be used instead of acd_queue_id. The ACD queue name list separated by the ';' symbol.

  • bind:

    booleanDefaults to true

    Bind or unbind?

Returns

  • result:

    number

    1

Examples

request:

Bind the skills 1, 5 to the users 5, 6, 10.

https://api.voximplant.com/platform_api/BindSkill/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&skill_id=1;3&user_id=5;6;10

Bind the all skill to the queues 11, 12.

https://api.voximplant.com/platform_api/BindSkill/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&skill_id=all&acd_queue_id=11;12&bind=true

Unbind the skills 1, 6 from the all users and the queues 11, 12.

https://api.voximplant.com/platform_api/BindSkill/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&skill_id=1;6&acd_queue_id=11;12&user_id=all

response:

Success.

{
    "result": 1
}

Deletes the skill.

Parameters

  • Follow link for authentication parameter names and details.

  • skill_id:

    number

    The skill ID.

  • skill_name:

    string

    The skill name that can be used instead of skill_id.

Returns

  • result:

    number

    1

Examples

request:

Delete the skill 1.

https://api.voximplant.com/platform_api/DelSkill/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&skill_id=1

response:

Success.

{
    "result": 1
}

Gets the skills.

Parameters

  • Follow link for authentication parameter names and details.

  • skill_id:

    number

    The skill ID to filter.

  • skill_name:

    string

    The skill name part to filter.

  • count:

    numberDefaults to 20

    The max returning record count.

  • offset:

    numberDefaults to 0

    The first N records will be skipped in the output.

Returns

  • result:

    [ SkillInfoType ]
  • total_count:

    number

    The total found skill count.

  • count:

    number

    The returned skill count.

Examples

request:

Get two skills, but skip the first one.

https://api.voximplant.com/platform_api/GetSkills/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&offset=1&count=2

response:

{
    "count": 2,
    "result": [
        {
            "skill_id": 3,
            "skill_name": "English"
        },
        {
            "skill_id": 5,
            "skill_name": "Support"
        }
    ],
    "total_count": 17
}

Edits the skill.

Parameters

  • Follow link for authentication parameter names and details.

  • skill_id:

    number

    The skill ID.

  • skill_name:

    string

    The skill name that can be used instead of skill_id.

  • new_skill_name:

    string

    The new skill name. The length must be less than 512.

Returns

  • result:

    number

    1

Examples

request:

Change the skill name.

https://api.voximplant.com/platform_api/SetSkillInfo/?account_id=1&api_key=eec36d6c-a0eb-46b5-a006-1c2b65343bac&skill_id=1&new_skill_name=Support

response:

Success.

{
    "result": 1
}