ListAnnotationMission-阿里云帮助中心

Lists annotation missions.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

outboundbot:ListAnnotationMission

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AnnotationMissionId	string	No	Annotation mission ID	0943abcb-bd7d-4ace-8cf7-97d39d4dd0b9
AnnotationMissionName	string	No	Annotation mission name	全景服务场景-标注任务-20230316-103253
AnnotationStatusListFilter	array	No	Annotation status filter. Deprecated.
	integer	No	Filter condition. Deprecated.	[1]
AnnotationStatusListStringFilter	string	No	Annotation status filter Note Format: [1]. You can specify multiple values. Valid values: 1: In progress 2: Completed 3: Closed	[1]
CreateTimeStartFilter	integer	No	Start time of the annotation mission creation filter	1661961600000
CreateTimeEndFilter	integer	No	End time of the annotation mission creation filter	1673280000000
PageIndex	integer	No	Page number	1
PageSize	integer	No	Number of entries per page	10
InstanceId	string	No	Instance ID	191ef468-75a2-4004-9441-a5c31bf5cd9d

Response elements

Element	Type	Description	Example
	object	BaseResponse<GetAnnotationMissionListResponse>
Success	boolean	Indicates whether the call succeeded. true: succeeded. false: failed.	true
Code	string	Response code	OK
Message	string	Additional information. Returns success for normal requests. Returns a specific error code for abnormal requests.	CDR 'job-c7b8a817-b8e8-40f3-b7ad-f28dcea218ff' doesn't exists.
Data	object	Data
AnnotationMissionList	array<object>	Annotation mission list
	object	Annotation mission
AnnotationMissionDataSourceType	integer	Annotation data source type. 1: Outbound call. 2: Navigation.	1
InstanceId	string	Instance ID	32be9d94-1346-4c4a-a4d0-ccd379f87013
AnnotationMissionId	string	Mission ID	ddce607f-f537-4ebd-9914-cf45671defb9
AnnotationMissionName	string	Mission name	体验场景--移车-标注任务-20230220-141347
AnnotationStatus	integer	Annotation status 1: In progress 2: Completed 3: Closed	1
CreateTime	integer	Creation time	1676170339515
SessionTotalCount	integer	Total number of sessions in the annotation mission	1
SessionFinishCount	integer	Number of completed sessions in the annotation mission	1
FinishTime	integer	Completion time of the annotation mission	1683443903785
ExcludeOtherMissionSession	boolean	Indicates whether to exclude call records already annotated in other missions	false
SessionEndReasonFilterList	array	List of session end reason types used when creating the mission 1: Normal completion 2: Bot hangup after rejection 3: Hangup due to silence timeout 4: User hangup after rejection 5: User hangup without reason 6: Transfer to agent after intent match 7: Transfer to agent after rejection 8: No interaction from user side 9: System exception interruption 10: Transfer to IVR after intent match 11: Transfer to IVR after rejection
	integer	Session end reason type used when creating the mission	[1]
ConversationTimeStartFilter	integer	Start time of the conversation time query condition for the annotation mission	1683216000000
ConversationTimeEndFilter	integer	End time of the conversation time query condition for the annotation mission	1684511999000
SamplingType	integer	Sampling type	1
SamplingRate	integer	Sampling rate	1
SamplingCount	integer	Maximum sampling count limit	1
SamplingDescription	string	Sampling description	标注
AnnotationMissionDebugDataSourceList	array	Annotation debug data source list Note The response includes an extra 0. Valid responses are [0,1], [0,2], or [0,1,2].
	integer	Annotation debug data source 1: Outbound task 2: Test task	[1]
PageIndex	integer	Page number	1
PageSize	integer	Number of entries per page	10
TotalCount	integer	Total count	30
TotalPageCount	integer	Total number of pages	4
Success	boolean	Indicates whether the call succeeded. true: succeeded. false: failed.	true
Message	string	Additional information. Returns success for normal requests. Returns a specific error code for abnormal requests.	CDR 'job-c7b8a817-b8e8-40f3-b7ad-f28dcea218ff' doesn't exists.
HttpStatusCode	integer	HTTP status code	200
RequestId	string	Request ID	254EB995-DEDF-48A4-9101-9CA5B72FFBCC

Examples

Success response

JSON format

{
  "Success": true,
  "Code": "OK",
  "Message": "CDR 'job-c7b8a817-b8e8-40f3-b7ad-f28dcea218ff' doesn't exists.",
  "Data": {
    "AnnotationMissionList": [
      {
        "AnnotationMissionDataSourceType": 1,
        "InstanceId": "32be9d94-1346-4c4a-a4d0-ccd379f87013",
        "AnnotationMissionId": "ddce607f-f537-4ebd-9914-cf45671defb9",
        "AnnotationMissionName": "体验场景--移车-标注任务-20230220-141347",
        "AnnotationStatus": 1,
        "CreateTime": 1676170339515,
        "SessionTotalCount": 1,
        "SessionFinishCount": 1,
        "FinishTime": 1683443903785,
        "ExcludeOtherMissionSession": false,
        "SessionEndReasonFilterList": [
          0
        ],
        "ConversationTimeStartFilter": 1683216000000,
        "ConversationTimeEndFilter": 1684511999000,
        "SamplingType": 1,
        "SamplingRate": 1,
        "SamplingCount": 1,
        "SamplingDescription": "标注",
        "AnnotationMissionDebugDataSourceList": [
          0
        ]
      }
    ],
    "PageIndex": 1,
    "PageSize": 10,
    "TotalCount": 30,
    "TotalPageCount": 4,
    "Success": true,
    "Message": "CDR 'job-c7b8a817-b8e8-40f3-b7ad-f28dcea218ff' doesn't exists."
  },
  "HttpStatusCode": 200,
  "RequestId": "254EB995-DEDF-48A4-9101-9CA5B72FFBCC"
}

Error codes

HTTP status code	Error code	Error message	Description
500	InternalError	An error occurred while processing your request. Please try again later. Submit a ticket if the error still exists.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.